API tokenBenef - Token de Atendimento

CONTEÚDO

1. Visão Geral
2. Configurações INI
3. Verbos
4. Uso da API - POST
5. Atributos de Resposta
6. Exemplos de JSON de Resposta
7. 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.

Sempre que uma solicitação de token for realizada, o registro da solicitação será realizada na tabela B74 - Reg Solicitacoes Token Acesso.

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:

Exemplo Configuração REST

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:

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

06. EXEMPLOS DE JSONS DE RESPOSTA

{
    "subscriberId": "00010050000002004",
    "token": "389159"
}

{
    "code": 400,
    "message": "Beneficiario informado nao encontrado",
    "detailedMessage": "Entre em contato com o Suporte",
    "helpUrl": "",
    "details": [
        {
            "code": "",
            "message": "",
            "detailedMessage": "",
            "helpUrl": ""
        }
    ]
}

07. TABELAS UTILIZADAS

Atualização do Arquivo SX2 (Tabelas):

• Tabela B74

Atualização SIX (Índices)

• Tabela B74:

Atualização do Arquivo SX3 (Campos): 

• Tabela BA1:

• Tabela B74: