Skip to main content

Gerar uma API key

  1. Acesse a plataforma Cordialy
  2. Vá em Integrações → API Keys
  3. Clique em Nova chave
  4. Dê um nome descritivo (ex: producao-crm, erp-interno)
  5. Copie a chave gerada — ela só aparece uma vez
Guarde a chave em um local seguro imediatamente. Após fechar o modal, não é possível visualizá-la novamente. Se perder, crie uma nova.

Usar a API key

Inclua a chave no header X-API-Key em todas as requisições:

Erros de autenticação

Boas práticas de segurança

API keys devem ficar apenas no backend. Se exposta no código do browser, qualquer pessoa pode usá-la para enviar mensagens ou acessar seus dados.
Nunca commite a chave no código-fonte. Use .env em desenvolvimento e variáveis de ambiente seguras em produção (AWS Secrets Manager, Vercel Env, Railway Variables, etc.).
Use chaves diferentes para desenvolvimento, staging e produção. Assim você pode revogar uma sem afetar as outras.
Se um sistema foi descontinuado ou uma chave foi exposta acidentalmente, revogue imediatamente em Integrações → API Keys.

Múltiplas chaves

Você pode ter várias chaves ativas ao mesmo tempo — útil para integrar diferentes sistemas (CRM, ERP, e-commerce) com controle individual. Cada chave pode ser revogada sem afetar as demais.