Skip to main content

Autenticação

Todas as requisições à API requerem o header X-Api-Key.

Tipos de API Key

Master API Key

A master key fornece acesso total a todos os endpoints, incluindo gerenciamento de contas (criar, atualizar, desativar contas).
X-Api-Key: SUA_MASTER_API_KEY
Utilizada para:
  • Criar e gerenciar contas (/accounts/*)
  • Listar templates de qualquer conta
  • Operações administrativas

API Key da Conta

Cada conta recebe uma API key única ao ser criada (formato: wk_<64-char-hex>). Esta chave é restrita a uma única conta.
X-Api-Key: wk_a1b2c3d4...
Utilizada para:
  • Enviar mensagens (/messages/*)
  • Listar templates (/templates)

Respostas de Erro

StatusDescrição
401API key ausente ou inválida
403API key não tem permissão para este endpoint
{
  "statusCode": 401,
  "message": "Missing X-Api-Key header"
}

Boas Práticas de Segurança

  • Armazene API keys em variáveis de ambiente, nunca no código-fonte
  • Rotacione as API keys das contas periodicamente usando POST /accounts/:id/regenerate-key
  • Use a master key apenas para operações administrativas
  • Use chaves específicas da conta para enviar mensagens