Menu

Conceitos

Autenticação e escopos

Chave por usuário, papéis, escopos e boas práticas.

A chave age como você

Cada chave pertence a um usuário da conta e age como esse usuário, nunca com mais acesso. O que ela pode fazer é a interseção de:

  1. os escopos escolhidos na chave;
  2. o papel atual do usuário (dono, administrador, membro ou leitura) — se o papel mudar, a chave muda junto;
  3. os módulos do plano e o acesso do membro;
  4. no teste grátis, só leitura.

Se o usuário sair da conta ou for desativado, a chave para de funcionar na hora.

Como enviar

Authorization: Bearer czk_live_SUA_CHAVE

Também aceitamos o header api-access-token: czk_live_… (com hífen; proxies descartam headers com sublinhado). Nunca envie a chave na URL.

Escopos

EscopoO que permite
account:readVer a conta, os membros e o plano
contacts:readVer contatos, listas, etiquetas e campos
contacts:writeCriar e editar contatos, listas, etiquetas e campos
contacts:deleteExcluir contatos
conversations:readVer conversas e mensagens da caixa
conversations:writeAtribuir, resolver, etiquetar e anotar conversas
messages:sendEnviar mensagens e templates pelo WhatsApp
whatsapp:readVer números, saúde e templates
templates:writeCriar e excluir templates na Meta
campaigns:readVer campanhas e métricas
campaigns:writeCriar, iniciar, pausar e cancelar campanhas
deals:readVer funis, etapas e negócios
deals:writeCriar, editar e mover negócios
automations:readVer automações
automations:writeInscrever e remover contatos de automações
agents:readVer agentes de IA
agents:writeAtivar, pausar e assumir conversas dos agentes
webhooks:manageGerenciar webhooks de saída
analytics:readVer relatórios

Membros não têm contacts:delete, templates:write nem webhooks:manage (só donos e administradores). Usuários de leitura só têm escopos :read.

Segurança

  • Guarde a chave num cofre de senhas ou variável de ambiente, nunca no código nem no navegador.
  • Use IPs permitidos quando o seu servidor tiver IP fixo.
  • Dê só os escopos necessários e uma validade.
  • Se vazar, revogue em Configurações → API pública: vale na hora.