# Início

Nesta modalidade de integração, disponibilizamos uma URL para redirecionamento em que recebemos os parâmetros exigidos do atendimento e cadastramos/autenticamos o beneficiário, retornando o resultado da checagem para o seu sistema autorizador. A vantagem deste modo é que toda a parte de captura e verificação se existe já um cadastro para o beneficiário já está desenvolvida e basta nos enviar os parâmetros exigidos através de querystring.

# Requisitos

Recursos necessários no dispositivo que irá realizar a captura através da Integração via URL:

  • Sistema Operacional Windows 7 ou superior, com atualização de drivers gráficos recentes que sejam compatíveis com o recurso WEBGL2 e OpenGL ou Directx mais recente;
  • Navegador Google Chrome ou Mozilla Firefox com atualizações recentes;
  • Certificação SSL para conexões seguras na aplicação requerente da URL de integração no caso de abertura via iFrame;

Caso ocorrer algum problema após a integração ter sido realizada, veja a sessão de Resolução de Problemas.

# Fluxo da Integração via URL

Essa forma de integração é iniciada com a abertura de uma janela ou um iFrame no navegador com a URL de integração e os parâmetros necessários para autenticação do beneficiário que está sendo atendido.

Nossa aplicação irá realizar a identificação se o beneficiário já possui cadastro e iniciar o fluxo de verificação. Caso não tenha cadastro, é informado na tela do usuário para realizar o cadastro com foto ou prosseguir com o cadastro sem a captura (impossibilidade de captura de foto do beneficiário), sendo requisitado o envio da foto cadastral no próximo atendimento.

Caso já possua cadastro porém houve alguma situação que impediu a captura da foto do beneficiário, é possível prosseguir mediante Justificativa que será avaliada posteriormente pelos responsáveis pela auditoria de sua empresa.

Após concluído o fluxo de cadastro/autenticação, enviamos o resultado para o seu sistema autorizador em uma URL informada nos parâmetros do link da aplicação.

# Ambientes de Integração

Temos dois ambientes disponíveis para Integração e também caso seu sistema autorizador for o SGU, há uma URL específica para cada ambiente:

# Sandbox

Ambiente de integração com a URL:

URL PADRÃO

https://web.sandbox.biodoc.com.br/#/integration/verify?

URL PARA AUTORIZADOR SGU

https://web.sandbox.biodoc.com.br/#/sgu/verify?

# Produção

Ambiente de produção do BioDoc:

URL PADRÃO

https://web.biodoc.com.br/#/integration/verify?

URL PARA AUTORIZADOR SGU

https://web.biodoc.com.br/#/sgu/verify?

# Padrões de Envio

Existem dois padrões de URL disponíveis para Integração.

  • URL Padrão: integração padrão;
  • URL SGU: integração para autorizador SGU;

Apesar de parecidos, cada um deles possuem parâmetros e retornos específicos.

URL SGU

Caso seu autorizador seja SGU, basta configurar a biometria informando o token e a URL específica para SGU do BioDoc dentro das configurações do seu sistema.

Feito isso, a integração já estará realizada e será solicitado o cadastro / verificação do beneficiário no próximo atendimento

# URL Padrão

# Parâmetros de querystring para URL Padrão

Os parâmetros necessários deverão ser enviados através de querystring junto a URL de Integração.

Parâmetro Descrição Formato
token Token de integração da empresa que está realizando o atendimento. string
card Número do cartão do beneficiário. string
name Nome do beneficiário. string
details Campo livre para enviar informações pertinentes que queira salvar junto aos dados do atendimento. Esperamos um JSON com chave/valor. JSON / string
url URL de retorno da resposta do BioDoc para seu sistema autorizador após a conclusão do processo de verificação. Você pode incluir parâmetros necessários para identificação do atendimento no retorno da API. Exemplo: "https://autorizador/123456", onde o parâmetro 123456 pode ser o cartão do beneficiário. string
procedure Código do procedimento gerado na guia. Necessário ativação da Isenção por Procedimento. Utilizado para isentar o beneficiário. string

# Exemplo de Integração via URL Padrão através de um iFrame

Atente a um detalhe importante: é necessário inserir o atributo "allow='camera" para que o navegador permita o uso do dispositivo na janela de iFrame.

<!-- Exemplo da integração via URL Padrão através de um iFrame -->
<iframe
  src="https://web.sandbox.biodoc.com.br/#/integration/verify?card=1234567891234567&name=TESTE USUÁRIO&token=SEUTOKEN&details='{'chave': 'valor'}'&url=https://autorizador/1234567891234567/"
  allow="camera"
></iframe>

# Retorno

O BioDoc irá retornar as informações da verificação redirecionando a página para a URL de retorno informada com os parâmetros via querystring.

// Redirecionamento da página para a URL de Retorno com os parâmetros de retorno
window.location.href(
  "https://autorizador/123456?date=DATA DA VERIFICAÇÃO&response=CÓDIGO DA RESPOSTA&message=MENSAGEM DE RETORNO&card=CARTÃO DO BENEFICIÁRIO"
);

# Parâmetros de Retorno

Parâmetro Descrição Formato
date Data da verificação timestamp / string
response Código de Resultado da Verificação number
message Mensagem de Retorno da Verificação string
card Cartão do cartão do beneficiário do atendimento string

Os Códigos de Resultado da Verificação são:

Code Descrição
200 Requisição processada com sucesso
201 Requisição processada, dados criados com sucesso
400 Requisição mal formada, parâmetros inválidos
401 Erro de autorização
403 Acesso não permitido
422 Requisição recebida, no entanto, não foi possível concluir o processamento com êxito
500 Erro interno

# Resolução de Problemas

O BioDoc utiliza de tecnologias de ponta e que requerem atenções com relação a compatibilidade para o uso dos recursos e sua funcionalidade. Caso esteja ocorrendo problemas ao executar a aplicação, recorra a essas verificações:

  • Verifique se está acessando a aplicação através de uma conexão segura (https);
  • Verifique se você autorizou o uso da câmera pelo navegador;
  • Verifique se a câmera está conectada e instalada em seu dispositivo;
  • Verifique se ocorre o mesmo erro utilizando outro navegador moderno e atualizado (Chrome, Firefox, Edge);
  • Verifique se o driver do dispositivo gráfico está atualizado e instalado corretamente;
  • Verifique se há algum anti-vírus ou firewall bloqueando o acesso a câmera e aplicação;

# NÃO RECONHECIMENTO DE ROSTO VÁLIDO

Caso não esteja reconhecendo rosto válido em todas tentativas, verifique as seguintes configurações do navegador Chrome:

ALTERAÇÕES NO GOOGLE CHROME

  1. Acesse o endereço chrome://flags/ no navegador;
  2. Procure por 'webgl' na barra de pesquisa da página;
  3. Ative as configurações 'WebGL 2.0 Compute' e 'WebGL Draft Extensions';
  4. Procure por 'video' na barra de pesquisa da página;
  5. Ative/Desabilite a configuração 'Hardware-accelerated video decode';
  6. Desabilite a configuração 'D3D11 Video Decoder';
  7. Altere a configuração 'Choose ANGLE graphics backend' para OpenGL ou D3D9;

ATENÇÃO

Caso não tenha sucesso, o dispositivo pode não ser compatível.
Abra um chamado em nosso suporte para verificarmos as configurações e ajuda-los.

← Integração via API →