—Documentação

Autenticação.

A API usa autenticação Bearer com chaves de API geradas no painel. Toda requisição precisa de uma chave — não há endpoints públicos.

Cabeçalho

Inclua a chave no cabeçalho Authorization com o prefixo Bearer. Requisições sem chave retornam 401 Unauthorized.

cabeçalho obrigatório

Authorization: Bearer sk_live_91bc••••••••••••k_20

Prefixos de chave

O prefixo identifica o ambiente. Ele é seguro de logar — o segredo aparece apenas no momento da criação.

sk_sandbox_…Ambiente de testes. Dados fictícios, ilimitado, gratuito.
sk_live_…Produção. Consome cota do plano e gera cobrança em excedente.

Gerar uma chave

Acesse Chaves de API no painel, clique em “Nova chave” e escolha o ambiente. O segredo completo é mostrado uma única vez.

Trate chaves sk_live_ como senhas. Use variáveis de ambiente — nunca comite no repositório nem envie para o frontend.

Rotação e revogação

Para girar uma chave sem downtime: gere a nova, atualize sua aplicação, e revogue a antiga. Revogação é instantânea e irreversível.

# Listar chaves
curl https://api.cpfhub.com/v1/keys \
  -H "Authorization: Bearer sk_live_…"

# Revogar uma chave
curl -X DELETE https://api.cpfhub.com/v1/keys/k_2 \
  -H "Authorization: Bearer sk_live_…"

IP allowlist

Cada chave aceita uma lista de IPs ou CIDRs autorizados. Recomendado em produção. Configure em /chaves/[id] ou via API. Requisições de IPs fora da lista retornam 403 Forbidden com error.code = ip_not_allowed.