Obtendo o token de autenticação

Para utilizar a API é necessário obter um token de acesso (Bearer). Sempre que expirado o tempo de validade, o passo de requisição de um novo token de acesso deve ser repetido, porém atualmente permitimos que o tempo de validade do token não expire.

Após acessar a API do NDD Averba, dirija-se à chamada auth de serviços do usuário para realizar a autenticação. Utilize o direcionamento abaixo:

CODE

https://reader.nddaverba.com.br/api/auth/login

Será preciso informar um e-mail e senha para gerar o token e autenticar, podendo ser o mesmo acesso do portal NDD Averba ou um novo cadastro para usar a integração, se preferir.

Somente será possível utilizar a API após gerar e autenticar o token.

O token irá expirar a cada 60 minutos.

Resposta bem sucedida

Após realizar a requisição, com todos os critérios atendidos, será apresentada a resposta de sucesso abaixo:

CODE

{
  "status": "sucesso",
  "mensagem": "Usuário autenticado com sucesso!",
  "usuario": {
    "email": "email@email.com",
    "nome_usuario": Nome do Usuário",
    "tipo": "Cliente",
    "ativo": true
  },
  "token_acesso": "Valor do token de acesso"
}

Os valores apresentados na mensagem acima são uma representação para exemplificar uma mensagem de sucesso. Eles podem variar de acordo com o e-mail do usuário e token gerado individualmente.

Assim que a chamada para a autenticação for bem sucedida será possível prosseguir com as demais requisições da API.

Resposta com erro

Caso algum dos critérios para a requisição não seja atendido, como por exemplo usuário e senha incorretos, será apresentada a seguinte mensagem de erro na operação:

CODE

{
  "status": "erro",
  "mensagem": "E-mail e\/ou senha inválidos.",
}