Ir para o final dos metadados
Ir para o início dos metadados

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

Versão 1 Atual »

Screenshot 2024-03-14 at 16.51.38.png

Campo

Descrição

Nome

Nome para identificação da instância (exemplos: prod, hmg, test, prd_v1). Favor utilizar apenas letras, números e underline [a-z0-9_].

Endereço

Endereço (host ou IP) onde estará localizado a instância do OmniLink.

Versão

Versão do OmniLink que será utilizada em runtime.

Módulo

Módulo de endpoints que essa instância irá atender.

Chave de API (opcional)

Caso queira adicionar uma chave de API para uma camada extra de segurança. Esta chave deve ser enviada através do header "apiKey" quando for configurar as integrações.

Modo debug

Quando ativado o modo debug habilita o endpoint GET /debug para devolver informações relevantes durante o processo de implantação para resolver problemas de interação com o banco de dados.

Logo (url imagem)

Endereço (url) de uma imagem para ser utilizada nas impressões diversas. Pode ser utilizada uma imagem do tipo PNG ou JPG. Recomendado uma imagem 1:1 (quadrada) com dimensões de 120px. Os assets do esquema de cor pode ser reutilizado. Exemplo: https://omnilink-assets.s3.amazonaws.com/omnilink-logo.png

Screenshot 2024-03-14 at 16.55.01.png

Campo

Descrição

Algoritmo da senha

Indica o algoritmo de hash que será aplicado na senha ao ser passada para as procedures de autenticação.

IDs das colunas de resposta

IDs das colunas que irão compor a resposta esperada da busca de beneficiários, em formato CSV. Devem possuir colunas correspondentes na tabela de beneficiários. Exemplo: nome_social,data_nascimento,cpf,email,plano_descricao

Descrição das colunas de resposta

Descrição das colunas que irão compor a resposta esperada da busca de beneficiários, em formato CSV. Atente-se para que estejam na mesma ordem dos IDs. Exemplo: Nome,Data de nascimento,CPF,E-mail,Plano contratado

Parâmetros de busca

Parâmetros que poderão ser utilizados para realizar a busca de beneficiários, em formato CSV. Devem possuir colunas correspondentes na tabela de beneficiários. Exemplo: cpf,nome,telefone_celular

  • Sem rótulos