Skip to main content

API Keys

Em /dashboard/api a organização gerencia as chaves de API que dão acesso programático aos recursos da plataforma. Cada chave pertence a uma organização, tem um conjunto de escopos e pode ser revogada a qualquer momento.

Tipos de chave​

  • Live (sk_live_...) — usadas em produção. Operam contra dados reais e geram cobranças reais.
  • Test (sk_test_...) — apontam para o sandbox; ideal para integração inicial e testes automatizados.

Criar uma chave​

  1. Clicar em Nova chave.
  2. Dar um nome descritivo (ex.: "Backend produção", "Worker de importação").
  3. Selecionar os escopos:
    • subscriptions:read / subscriptions:write
    • invoices:read / invoices:write
    • payments:read / payments:write
    • customers:read / customers:write
    • nfes:read / nfes:write
    • webhooks:manage
  4. Opcionalmente restringir por IP (lista de prefixos CIDR).
  5. A chave é exibida uma única vez após criada. Copiar e guardar em cofre.

Boas práticas​

  • Uma chave por aplicação — facilita revogar acesso sem impactar outros sistemas.
  • Escopos mínimos — conceder apenas o que a aplicação precisa.
  • Rotação periódica — gerar nova chave, atualizar a aplicação e revogar a antiga.
  • Nunca commitar — chaves devem viver em variáveis de ambiente ou cofre de segredos.

Rate limits​

Cada chave respeita os limites configurados em Rate Limiting. Excedentes retornam 429 Too Many Requests com header Retry-After.

Auditoria e uso​

A página mostra:

  • Status — active ou revoked
  • Último uso — data, IP e endpoint chamado
  • Volume — requisições nas últimas 24h e nos últimos 30 dias

Toda criação ou revogação é registrada em Auditoria.

Documentação da API​

A referência completa dos endpoints está disponível na seção API do menu lateral.

Captura de tela​

Lista de API keys com nome, escopos, último uso e status