Geração de token temporário

Índice

Só são suportadas integrações no padrão REST.

Orientações

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

Critérios de preenchimento

Abreviação	Nome	Descrição
M	Mandatório	O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado.
C	Condicional	O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado.
OP	Opcional	Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array.

Método de gerar token temporário

Atente-se as orientações fornecidas pela Mobile Saúde;
Atente-se aos critérios de preenchimento;
Atente-se aos critérios de objetos e atributos de retorno;
Atente-se as mensagens de retorno para cada HTTPS Status Code;

Endpoint

Endpoint	Método	Header Content-Type	Descrição
http://exemplo.com/ /clientes/auth/temp-authorization	POST	application/json	Endpoint para gerar token temporário.

Headers

Parâmetro	Obrigatório	Tipo	Descrição
Authorization	M	String	Token de autenticação da operadora.
content-type	M	application/json	Tipo de Conteúdo enviado para a requisição.

Descrição dos objetos e atributos de retorno - Sucesso

Atributo	Critério	Tipo	Descrição
message	M	String	Mensagem com motivo do erro.
status	M	Boolean	Status de retorno.
data	M	Object	Dados do token temporário.
statusCode	M	Number	Código de status HTTP.
timestamp	M	Number	Data do retorno do resultado.

Objeto data

Atributo	Critério	Tipo	Descrição
token	M	String	Token a ser utilizado nas requisições onde a autenticação temporária é aceita.
expireAt	M	Number	Data em timestamp que o token será expirado. O token sempre será expirado 12 horas após ser gerado.

Exemplo retorno API - sucesso

{
    "status": true,
    "data": {
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJhNTNiYTg3MmYxY2VhZjQzNzA2OTFiYzIxOWNiOTJjODI1YWNiNjc3MzllYjc4YTg4MjJjZWE1YTIyNjdjYjhjIiwiYXVkIjoiY2xpZW50ZV90ZW1wb3JhcmlvIiwiaWRDbGllbnRlIjo0OTIsImlhdCI6MTY4OTAxMDA2MywiZXhwIjoxNjg5MDUzMjYzfQ.G9jgfwozpPa7Orn9fe7KHE5dJ4UgCpxbyxeNJ449Amk",
        "expireAt": 1689053263462
    },
    "message": "Token gerado com sucesso!",
    "statusCode": 200,
    "timestamp": 1689010063463
}

Descrição dos objetos e atributos de retorno - falha

Está indicado abaixo a estrutura de retorno do seu método listaDebitos. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.
Atente-se as mensagens de retorno para cada HTTPS Status Code;

O erro sempre é retornado no status code 401, não autorizado.

Atributo	Critério	Tipo	Descrição
message	M	String	Mensagem com motivo do erro.
success	M	Boolean	Sempre retornará false

Exemplo retorno API - falha

{
    "success": false,
    "message": "Invalid token."
}