Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.haldenhub.com/llms.txt

Use this file to discover all available pages before exploring further.

A API Key é a forma de autenticação para chamadas server-to-server do ConsentFly. Cada chave é única, associada à sua conta, e pode ser gerada no painel após o login.

​
Como obter sua API Key

  1. Acesse www.consentfly.com.br e faça login.
  2. No menu lateral abra API Keys.
  3. Clique em Gerar nova chave e copie o valor imediatamente.
A chave é exibida apenas uma vez, no formato: 
sk-rQiYxSxAdIvJpemBGWnxoemdgyHIWQxs
Atenção: a chave equivale a uma senha. Nunca a coloque em código de frontend, repositórios públicos ou logs.

​
Como usar a API Key

Envie a chave no header Authorization, prefixada por Bearer: 
GET /api/v1/consents?site_id=<site_uuid> HTTP/1.1
Host: www.consentfly.com.br
Authorization: Bearer sk-rQiYxSxAdIvJpemBGWnxoemdgyHIWQxs

​
Endpoints que aceitam API Key (e cota)

Documentação narrativa: API de consentimentos. Referência OpenAPI: aba API Reference (tags Consents e API Key). Rotas /api/v1/consents (GET lista, GET detalhe, POST, PUT, DELETE, GET history) aceitam Bearer sk-... ou sessão do dashboard. Apenas o uso com API Key desconta da cota abaixo. A exportação CSV GET /api/v1/sites/{siteId}/consents/export também aceita API Key para automação, mas não passa pelo contador de cota mensal usado nas rotas /consents.

​
Cota e plano

Cada requisição /consents autenticada com API Key consome 1 unidade da cota mensal. Chamadas ao mesmo endpoint com JWT (painel) não incrementam esse contador.
PlanoSites máximosRequisições API / mês
Free1100
Starter520.000
Pro2050.000
Enterprisecustomizadocustomizado
Quando você ultrapassar o limite a API responde 429 Too Many Requests com o código quota_exceeded. O contador é renovado conforme o período de uso da API (mensal).

​
Boas práticas

  • Use chaves diferentes por ambiente (dev, staging, produção).
  • Revogue chaves antigas pelo painel sempre que possível.
  • Monitore o erro unauthorized — ele significa que a chave foi revogada ou que a conta está com plan_status não-ativo.

Dúvidas? Fale com a gente em suporte@consentfly.com.br