SopagueDocs
v3

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

As URLs base de produção e homologação estão documentadas na página Ambientes.

Como autenticar

  1. Obtenha seu userName e password 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.
O token tem prazo de validade. Renove-o antes da expiração.

Endpoints de autenticação

API Gateway

POST /api/auth/token

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

Conciliação e Boletos

POST /api/authentication/login

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