Aparência

Autenticação ​

A integração se autentica com um usuário de API (criado no portal) e o da conta. A resposta traz um que vale 10 minutos.

1. Peça o token ​

http
POST /access/account/get-token
Content-Type: application/json

{
  "email": "erp@exemplo.com",
  "token": "SEU_ACCOUNT_TOKEN"
}
CampoObrigatórioO que é
emailSimE-mail do usuário de API
tokenSimAccount Token da conta

Resposta 200:

json
{
  "code": 200,
  "success": true,
  "data": {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
    "token_type": "Bearer",
    "expires_at": "2026-10-15T15:10:00-03:00",
    "permissions": [
      { "id": 14, "name": "create_charges", "guard_name": "api" },
      { "id": 6, "name": "send_pix", "guard_name": "api" }
    ]
  },
  "message": "Autenticado com sucesso."
}

permissions lista o que esse usuário de API pode fazer na conta: as permissões do papel técnico Usuário de API (Pix, TED, boletos, cobranças, clientes, saldo e extrato) mais as que forem dadas a ele. Sem a permissão de uma rota, a API responde 403 (veja Convenções da API).

Erros:

CódigoQuando
401E-mail não encontrado, Account Token inválido ou usuário sem acesso a essa conta
422email ou token ausentes ou em formato inválido

2. Envie o token em cada requisição ​

http
Authorization: Bearer {token}
Content-Type: application/json
account: {id da conta}
  • Authorization: o data.token do passo 1.
  • account: o id numérico da conta que vai ser operada. O usuário de API precisa ter acesso a ela. Se não tiver, a resposta é 403.

3. Renove antes de expirar ​

O token vale 10 minutos (expires_at). Peça um novo pelo mesmo POST /access/account/get-token antes de ele vencer, ou quando uma requisição responder 401.

Descrição do diagrama em texto

Peça o token, use-o nas requisições com os cabeçalhos Authorization e account e, quando a resposta for 401 ou o token estiver perto de expirar, peça um novo e continue.

Nunca no navegador

Faça a autenticação no servidor. O Account Token dá acesso à conta: se ele vazar, gere outro com o suporte e troque nas integrações.