Pular para o conteúdo principal

​
Bearer token

Toda requisição autenticada leva uma API key:
Crie e revogue chaves em Configurações → API & Webhooks no painel.
A chave é exibida uma única vez e dá acesso aos dados da sua organização. Guarde-a em um gerenciador de segredos, nunca em código de frontend ou em repositório.

​
Escopos

Chaves novas podem usar clients:read, clients:write, debts:read, debts:write, webhooks:read, webhooks:write, voice-calls:read e voice-calls:write. Uma requisição fora dos escopos da chave retorna 403. Endpoints que não declaram escopo são exclusivos do painel e rejeitam API keys com 403. Isso inclui gestão de chaves, cobrança da plataforma, configurações da organização e a configuração da régua (/collection).

​
Idempotência

Envie Idempotency-Key em POST e PATCH para que um retry não crie duplicatas:
As respostas ficam em cache por 24 horas por chave, organização e endpoint. Reusar a chave com outro payload retorna 409.

​
Rate limit

API keys são limitadas a 100 requisições por minuto por padrão. As respostas trazem X-RateLimit-Limit e X-RateLimit-Remaining; um 429 também traz Retry-After. O corpo do erro segue a RFC 9457 com code = RATE_LIMITED.