Todas as chamadas de API (exceto obtenção do token) exigem autenticação via Bearer token.

Como autenticar

1. Obtenha suas instruções de credenciais com a equipe Sopague.
2. Faça a chamada de login no endpoint correspondente à sua API.
3. Copie o accessToken da resposta.
4. Envie o token em todas as requisições seguintes.

Endpoints de autenticação

API Gateway

POST /api/auth/token

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

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

Conciliação e Boletos

POST /api/authentication/login

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

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

Consulta da Access-Key

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