Autenticação

POST/api/auth/token

Gera o token de acesso utilizado para autenticar as requisições à API do Gateway de Pagamentos.

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"
}

Uso do token

O accessToken pode já incluir o prefixo Bearer . Nesse caso, use o valor retornado diretamente no header Authorization. Caso contrário, adicione o prefixo uma única vez.

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.

Consulta da Access-Key

Caso seja necessário consultar a Access-Key, é possível realizar a consulta utilizando o header específico.

Para consultar a Access-Key

Envie uma requisição utilizando o header Include-Access-Key:

Include-Access-Key: true

Após realizar a requisição, a API retornará a accesskey na resposta.

Exemplo de resposta:

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

É recomendado manter o header Include-Access-Key inativo quando a consulta não for necessária.

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.

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "Password": [
      "The Password field is required."
    ],
    "UserName": [
      "The UserName field is required."
    ]
  },
  "traceId": "00-a8122a2600c1fe1306893592fbbf9b23-e4d96fea278152e2-00"
}

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.