Autenticação

O token de aplicação é a credencial que identifica a sua integração e dá acesso aos dados da organização.

Toda rota da API exige um token de aplicação.

Obter o token

A gestão dos tokens é feita no Painel, na área de integrações da sua organização: é lá que você cria um token, define as permissões dele e o revoga quando não for mais necessário.

⚠️

O token é um secret. Trate-o com o mesmo cuidado que você daria a uma senha.

Enviar o token

O token vai no header Authorization, no esquema Bearer:

curl "https://api.prod.pixlog.com.br/v1/scans" \
  -H "Authorization: Bearer $PIXLOG_API_TOKEN"

Requisição sem Authorization responde 401. Token revogado, vencido ou sem a permissão exigida pela rota responde 401 ou 403. A lista completa de códigos está em Erros.

Limite de uso

A API aceita 55 requisições por minuto. O limite vale por organização, não por token: todos os tokens da mesma organização dividem a mesma cota.

Ao estourar, a resposta é 429 e traz o header Retry-After, em segundos, indicando quando tentar de novo.

Organizações com necessidade maior podem ter a cota ajustada. Entre em contato pelo e-mail [email protected].