Autenticação

API keys, headers e escopos da API pública.

Autenticação

A API pública usa API keys no formato ak_live_<secret>.

Headers

Você pode autenticar de duas formas equivalentes:

Header	Valor
Authorization	Bearer ak_live_<secret>
X-Api-Key	ak_live_<secret>

# Bearer
curl -sS https://api.aideskbr.com/api/public/v1/ping \
  -H 'Authorization: Bearer ak_live_SUA_KEY'

# X-Api-Key
curl -sS https://api.aideskbr.com/api/public/v1/ping \
  -H 'X-Api-Key: ak_live_SUA_KEY'

Organização

A organização é resolvida pela key. Não envie:

• organization_id no body
• X-Organization-Id nestas rotas

Escopos

Scope	Endpoints
messages:send	POST /messages
messages:read	GET /messages/{id}
contacts:read / contacts:write	Resolve/cria contato no envio com to
templates:read	Uso de templates no envio
webhooks:manage	CRUD de webhooks

Defaults na criação da key: messages:send, messages:read, contacts:read, contacts:write, templates:read.

webhooks:manage não vem no default. Inclua explicitamente ao criar ou rotacionar a key no app.

Ciclo de vida

• O secret completo é exibido apenas uma vez na criação/rotação.
• Key revogada ou expirada → 401 no próximo request.
• Mensagens já enfileiradas antes da revogação seguem no worker de outbound.

Como criar a key

No app: Integrações → API keys (requer permissão de admin/owner com integrations.manage_api).