# Métodos de isenções externas da plataforma

# Isenção por Integração

# Introdução

Na seção de Empresas do sistema, é possível habilitar a funcionalidade de isenção por integração. Essa funcionalidade permite que sistemas externos façam a verificação de isenção diretamente por meio de integração. Abaixo estão os detalhes técnicos necessários para implementar essa comunicação com empresas que possuem a isenção ativada.

# Estrutura da Integração

# Campos de Entrada

  • URL de Integração: O cliente deve inserir o endpoint de destino no campo destinado à URL de integração.
  • Credenciais: As credenciais de autenticação para o endpoint externo devem ser inseridas nos seguintes campos:
    • Usuário (user)
    • Senha (password)

# Envio de Dados

Ao realizar a requisição para o endpoint especificado, as credenciais de autenticação (usuário e senha) devem ser enviadas no cabeçalho da solicitação, utilizando a autenticação do tipo Basic. O cabeçalho da solicitação deve seguir o seguinte formato:

Authorization: Basic <Base64(user:password)>

# Formato da Requisição

A requisição deve ser do tipo POST, e o corpo da solicitação deve estar em formato JSON. O exemplo abaixo mostra a estrutura esperada do corpo da requisição:

{
  "idCard": "<valor_do_idCard>"
}

# Resposta da Requisição

Após o envio da requisição, a resposta esperada será um objeto JSON com a seguinte estrutura:

{
  "result": true
}

# Interpretação da Resposta

  • Se o valor de "result" for true, isso indica que o cliente está isento.
  • Se o valor de "result" for false, isso indica que o cliente não está isento.

# Considerações Finais

Para garantir o sucesso da integração, certifique-se de que:

  • As credenciais fornecidas estão corretas.
  • A URL de integração está corretamente configurada.
  • O tratamento adequado das respostas seja implementado, garantindo o fluxo correto das operações de isenção.

# Isenção por Procedimento

# Introdução

A Isenção por Procedimento é uma funcionalidade oferecida pelo nosso sistema que permite que determinados procedimentos médicos, ao serem realizados, sejam automaticamente isentos da verificação biométrica do beneficiário. Esta funcionalidade pode ser integrada de duas formas: via URL e via API.

Para utilizar essa funcionalidade, a empresa deve configurar previamente os procedimentos que serão isentos em nossa plataforma. Os procedimentos podem ser cadastrados com base no código ou nome do procedimento e devem ser enviados exatamente como serão utilizados no parâmetro procedure nas requisições.

Quando o parâmetro isenção por procedimento estiver habilitado, e o valor enviado no parâmetro procedure corresponder ao cadastro existente na plataforma, o beneficiário será automaticamente isento de passar pela biometria.

# Integração via URL

Na integração via URL, os parâmetros necessários são enviados por meio da querystring da URL de integração. Veja abaixo os detalhes dos parâmetros necessários, incluindo o uso do parâmetro procedure.

# Parâmetros de Querystring para URL Padrã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 adicionais em formato JSON, como chave/valor. JSON / string
url URL de retorno para seu sistema autorizador após a conclusão do processo de verificação biométrica. string
procedure Código do procedimento gerado na guia. Necessário para ativação da Isenção por Procedimento. string

# Exemplo de URL de Integração com Isenção por Procedimento:

https://web.sandbox.biodoc.com.br/#/integration/verify?card=1234567891234567&name=TESTE USUÁRIO&token=SEUTOKEN&details='{'chave': 'valor'}'&url=https://autorizador/1234567891234567/&procedure=PROC001

# Integração via API

Na integração via API, o parâmetro procedure pode ser utilizado em chamadas para endpoints específicos, como a busca da imagem principal de um cartão. A seguir estão os detalhes do endpoint relevante para a Isenção por Procedimento.

# Endpoint: /card/integration/mainimage

  • Descrição: Responsável por realizar a busca da imagem principal de um cartão.
  • Método: GET
  • Formato dos parâmetros: Querystring

# Parâmetros da Requisição

Parâmetro Descrição Formato
idCard Número identificador do cartão do beneficiário. string
procedure Código do procedimento. Utilizado para ativar a Isenção por Procedimento. string

# Exemplo de Requisição API com Isenção por Procedimento:

/card/integration/mainimage?idCard=1234567890&procedure=PROC001

# Funcionamento da Isenção por Procedimento

# Configuração na Plataforma

Para que o parâmetro procedure funcione corretamente na integração, a empresa deve primeiro configurar, em nossa plataforma, os procedimentos que serão isentos de biometria. Isso pode ser feito informando o código ou nome do procedimento durante o cadastro.

Ao utilizar o parâmetro procedure nas requisições, a plataforma verificará se o valor enviado corresponde a algum dos procedimentos configurados para isenção. Caso haja correspondência, o beneficiário será isento de realizar a verificação biométrica.

# Como o Parâmetro procedure Funciona

  1. Envio do Parâmetro: Quando a isenção por procedimento está ativada, o cliente deve enviar o parâmetro procedure com o código ou nome do procedimento durante a requisição.
  2. Verificação na Plataforma: O sistema validará o valor enviado com os procedimentos cadastrados na plataforma.
  3. Isenção: Se o valor do procedure for válido e estiver cadastrado, o beneficiário será automaticamente isento de biometria para aquele atendimento.

←