Autenticação

POST/api/authentication/login

Gera o token de acesso utilizado para autenticar as requisições à API de Conciliação e Boletos.

Consulte as URLs de produção e homologação na página Ambientes e obtenha suas credenciais com a equipe ENOQ Pay.

Exemplo de requisição

{
  "userName": "seu-usuario",
  "password": "sua-senha"
}

Exemplo de resposta

{
  "authenticated": true,
  "created": "2023-01-01T14:25:28.913Z",
  "expiration": "2023-01-01T14:25:28.913Z",
  "accessToken": "string",
  "message": "string"
}

Verifique authenticated na resposta antes de usar o token. Em homologação, credenciais inválidas retornaram HTTP 200 com authenticated: false e a mensagem Credenciais inválidas!. O status HTTP 200, sozinho, não indica sucesso na autenticação.

Uso do token

Copie o accessToken da resposta e envie-o no header das próximas requisições:

Authorization: Bearer {accessToken}

O token tem prazo de validade. Consulte expiration e obtenha um novo token antes da expiração.

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Observado em homologação

Requisição de autenticação com corpo JSON vazio: usuário e senha não foram enviados.

[
  {
    "key": "",
    "message": "Credenciais inválidas!"
  }
]

Campos da resposta de erro

A tabela reúne os campos presentes nos exemplos acima. Uma resposta HTTP sem corpo não inclui esses campos.