Skip to main content

​
API keys

API keys permitem que o seu CRM, ERP ou backend envie mensagens e receba webhooks pela API pública. Documentação técnica completa: developers.aideskbr.com.

​
Quem pode criar

Owners/admins com permissão integrations.manage_api (padrão para esses papéis).

​
Como criar (visão produto)

  1. Entre no app como admin.
  2. Abra as configurações de integrações / API keys da organização.
  3. Crie uma key com nome claro (ex. “CRM produção”).
  4. Escolha os scopes necessários (messages:send, messages:read, etc.).
  5. Copie o secret ak_live_... imediatamente — ele não é mostrado de novo.
  6. Guarde em um cofre de secrets (nunca no código-fonte público).
Para webhooks, inclua o scope webhooks:manage (não vem no default).

​
Rotacionar e revogar

  • Rotacionar — gera um secret novo (o antigo deixa de funcionar).
  • Revogar — invalida a key na hora para novos requests.
Mensagens já enfileiradas antes da revogação podem continuar no worker.

​
Base URL

Teste rápido:
Continue no Quickstart da API.