Árvore de páginas

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

POSThttps://<url>:porta>/rest/totvsHealthPlans/v1/facialRecognition
Solicita o endpoint do serviço de validação facial informando o beneficiario.
GEThttps://<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

CaracterSimMatricula do beneficiairo

alert

CaracterNão

Indica se deverá enviar o link pela rotina de notificações do PLS.

healthProviderId

CaracterNã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:

Nome

Tipo

Descrição

jRequest

O

Objeto Json do que foi enviado pelo portal autorizador




Retorno:

Nome

Tipo

Descrição

aRet[1]

C

Json para retorno ao portal autorizador

aRet[2]

N

Http code da transação(Ex: 200, 500)


Para correto funcionamento com o portal autorizador, é obrigatório retornar no json os campos 'id' e 'link'.


Ponto de Entrada

1
2
3
4
5
6
7
8
9
10

#include "PROTHEUS.CH"
 
User Function PLSRFACP
Local jRequest := paramixb[1]
Local cJson := '{    "id": "6tas66sad5f57as6d97asd","link":"www.meusitevalidador.com.br/1234"}'
Local nStatus := 200


Return {cJson,nStatus}



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:

Nome

Tipo

Descrição

jPath

O

Objeto Json do que foi enviado pelo portal autorizador




Retorno:

Nome

Tipo

Descrição

aRet[1]

C

Json para retorno ao portal autorizador

aRet[2]

N

Http code da transação(Ex: 200, 500)


Para correto funcionamento com o portal autorizador, é obrigatório retornar no json os campos 'finished' e 'approved'.


Ponto de Entrada

1
2
3
4
5
6
7
8
9
10

#include "PROTHEUS.CH"
 
User Function PLSRFACG
Local jRequest := paramixb[1]
Local cJson := '{    "finished": true,"approved":true}'
Local nStatus := 200


Return {cJson,nStatus}