01. VISÃO GERAL
A API tem como objetivo retornar o URL do serviço de validação facial e depos consultar o seu resultado.
02. VERBOS
Seguem os verbos disponíveis na API:
Verbo | URL | Descrição |
---|---|---|
POST | https://<url>:porta>/rest/totvsHealthPlans/v1/facialRecognition | Solicita o endpoint do serviço de validação facial informando o beneficiario. |
GET | https://<url>:porta>/rest/totvsHealthPlans/v1/facialRecognition/{id} | Consulta o resultado da validação facial. |
03. USO DA API - POST
Dados do body de envio:
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
subscriberId | Caracter | Sim | Matricula do beneficiairo |
alert | Caracter | Não | Indica se deverá enviar o link pela rotina de notificações do PLS. |
healthProviderId | Caracter | Não | Se o parametro 'alert' estiver como true e este campo preenchido o link será enviado para o prestador, se vazio será enviado para o beneficiario. |
04. USO DA API - GET
Enviar o ID disponibilizado na API POST para consultar o status.
05. PONTO DE ENTRADA
Descrição: | Ponto de Entrada para realizar a chamada de outro serviço de validação facial. | |||||||||
Localização: | Reconhecimento Facial POST | |||||||||
Nome: | PLSRFACP | |||||||||
Programa Fonte: | health.api.facialRecognition.request.tlpp | |||||||||
Parâmetros: |
| |||||||||
Retorno: |
|
Para correto funcionamento com o portal autorizador, é obrigatório retornar no json os campos 'id' e 'link'.
Ponto de Entrada
1 |
|
Descrição: | Ponto de Entrada para realizar a chamada de outro serviço de validação facial. | |||||||||
Localização: | Reconhecimento Facial GET | |||||||||
Nome: | PLSRFACG | |||||||||
Programa Fonte: | health.api.facialRecognition.request.tlpp | |||||||||
Parâmetros: |
| |||||||||
Retorno: |
|
Para correto funcionamento com o portal autorizador, é obrigatório retornar no json os campos 'finished' e 'approved'.
Ponto de Entrada
1 |
|