Histórico da Página
CONTEÚDO
- Visão Geral
- Exemplo de utilização
- Tela XXX
- Outras Ações / Ações relacionadas
- Outras Ações / Ações relacionadas
- Tela XXX
- Principais Campos e Parâmetros
- Principais Campos e Parâmetros
- Tabelas utilizadas
01. VISÃO GERAL
A API tokenBenef tem como objetivo retornar um token de validação para atendimento.
O Token é uma senha numérica de 6 a 8 dígitos gerada através de um algoritmo TOTP RFC6238 servindo como um segundo fator de autenticação, assegurando que quem está sendo atendido é mesmo o beneficiário portador da carteirinha informada.
Para configurar a geração/validação do Token de acesso seguir os passo do documento: Configuração Token PLS.
Importante: o token é gerado baseado em uma chave randômica (também conhecido como seed) que é armazenada no cadastro do beneficiário (BA1_TKSEED). Ao realizar uma solicitação para a API, caso a chave não tenha sido criada ainda, a mesma é gerada automaticamente e o token já é retornado com a chave gerada.
02. CONFIGURAÇÕES INI
Para iniciar a instalação do processo, devemos configurar seu INI Protheus com a funcionalidade REST para habilitar o acesso as API´s. Documentos auxiliares:
Com o INI Protheus configurado, a nomenclatura das API´s ficará no formato: <url + Porta + chave rest definidos no INI Protheus> + /totvsHealthPlans/v1/tokenBenef/<matric> . Exemplo:
Exemplo: para retornar o token da matrícula 00010050000002004, a minha URL será: http://localhost:8080/rest/totvsHealthPlans/v1/tokenBenef/00010050000002004/
03. VERBOS
Seguem os verbos disponíveis na API:
Verbo | Path | Descrição |
---|---|---|
POST | /tokenBenef/<matric> | Retorna o token de acesso para o beneficiário solicitado |
04. USO DA API - POST
A API não tem QueryParams específicos, ela solicita somente a matrícula do beneficiário que é passada como pathparam na URL.
Exemplo de chamada para utilização do beneficiário com matrícula 0001.0050.000002.00-4:
http://localhost:8080/rest/totvsHealthPlans/v1/tokenBenef/00010050000002004
05. ATRIBUTOS DE RESPOSTA
Atributo | Campo | Tipo | Descrição |
---|---|---|---|
subscriberId | BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO | String | Matrícula do Beneficiário |
token | BA1_TKSEED | String | Token de Atendimento |
06. EXEMPLOS DE JSONS DE RESPOSTA
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "subscriberId": "00010050000002004", "token": "389159" } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "code": 400, "message": "Beneficiario informado nao encontrado", "detailedMessage": "Entre em contato com o Suporte", "helpUrl": "", "details": [ { "code": "", "message": "", "detailedMessage": "", "helpUrl": "" } ] } |