Pular para o conteúdo principal
A chave de API é o cartão de acesso do seu sistema na Notifique. Sem ele na requisição, a porta nem abre.

​
O que é uma chave de API?

É a credencial que identifica quem está chamando a API e de qual workspace. Pense no cartão do prédio: você não precisa digitar login e senha em toda requisição, só apresentar o cartão no header. Cada chave começa com sk_live_... (produção) ou sk_test_... (sandbox).

​
Para que serve?

A chave conecta seu código à Notifique. Com ela você pode:
  • Enviar mensagens (WhatsApp, SMS, e-mail, push e outros canais)
  • Consultar histórico, status e mensagens recebidas
  • Gerenciar instâncias, templates, contatos e automações (conforme os escopos marcados)
Tudo isso sem sessão de usuário no painel. O servidor do seu app fala direto com a API.

​
Por que usar chaves separadas?

É como ter um cartão para cada funcionário: se um perder o dele, você cancela só aquele.

​
O que você pode fazer no painel

No Developer → API Keys, você gerencia os cartões do workspace:
  • Ver quais integrações já têm chave ativa
  • Criar uma chave nova com nome e permissões
  • Revogar uma chave comprometida sem derrubar as outras
  • Rotacionar acesso: uma chave por app, serviço ou ambiente
Cada chave pertence a um workspace (a pasta do seu cliente) e define o que aquela integração pode fazer.

​
Sandbox x Produção

É o mesmo prédio, portas diferentes:
  • Sandbox (sk_test_...): simulador de voo. Você testa o trajeto inteiro, mas ninguém recebe nada de verdade. Veja os envios em Developer → Inbox sandbox
  • Produção (sk_live_...): voo real. A mensagem sai e o crédito é debitado
Saiba mais sobre o sandbox →

​
Como criar uma chave

Chaves nascem no painel. Não dá para criar pela API pública:
  1. Abra Developer → API Keys
  2. Clique em Criar chave
  3. Dê um nome e marque os escopos: as portas que essa chave pode abrir
  4. Copie na hora. Começa com sk_live_... ou sk_test_...
A chave completa aparece só uma vez, como a senha de um cartão novo. Perdeu? Crie outra. Não dá para recuperar.

​
Como usar na integração

Em toda chamada à API, apresente o cartão no header Authorization:
Também aceitamos x-api-key no lugar de Authorization. O passo a passo completo está em Comece aqui.

​
Boas práticas

  1. Nunca deixe a chave no código público. Guarde em .env, como a senha do Wi-Fi do escritório
  2. Uma chave por integração. Se o app de testes vazar, o de produção continua seguro
  3. Vazou? Revogue em Developer → API Keys e emita outra na hora
Mais detalhes: Segurança e Confiabilidade.

​
Escopos e permissões

Escopos são as portas que cada chave abre. Marque só o que sua integração precisa. Não dê acesso ao estoque inteiro se só vai enviar SMS. Escolha o canal que vai integrar e veja a lista completa de permissões:

WhatsApp

Enviar, conectar número, grupos

SMS

Enviar, consultar, cancelar

Telegram

Enviar, conectar bot, ler mensagens

Instagram

Enviar, responder comentários

E-mail

Enviar, configurar domínio

Push

Enviar, gerenciar apps

RCS

Enviar, consultar, cancelar

Voz

Ligar, controlar, gravar

Templates

Criar modelos e disparar

Contatos e audiência

Contatos, tags, campanhas

Automações

Fluxos e eventos

Links curtos

Links e conversões

Números virtuais

Consultar e configurar

Add-ons de marketing

Formulários e integrações
Porta trancada? Veja Respostas de erro.

​
Catálogo de canais (GET /v1/meta/channels)

A plataforma expõe 9 canais oficiais na API v1: WhatsApp, Instagram, SMS, Telegram, E-mail, Push, RCS, Voz e Chat (API em tempo real no seu app — veja Introdução ao Chat). O nono canal não é o widget Chat no site: esse widget é um addon de IA para visitantes na página. O Chat API (/v1/chat/*) é conversa 1:1 e grupos com usuários autenticados no seu produto. GET /v1/meta/channels devolve o catálogo com capabilities e legacy por canal. No item whatsapp, capabilities.whatsapp inclui whatsapp_call: chamadas são recurso do WhatsApp, não um canal à parte (hoje só na conexão não oficial). O Notify (POST /v1/notify) faz cascata em 8 canais de envio — sem Chat.

​
Rate limit da API v1

Cada workspace tem limite de requisições por minuto conforme o plano (header X-RateLimit-Limit). Os valores vêm de PLAN_LIMITS[plano].rateLimitPerMin no backend. Ao estourar, a API retorna 429 com RATE_LIMIT_EXCEEDED e Retry-After (segundos até liberar). Exceções: GET /v1/*/instances (listagem para polling de conexão) e rotas de sync/connect não contam no limite.

​
Próximos passos

  • Comece aqui: envie sua primeira mensagem
  • Webhooks: receba avisos no seu servidor, como notificação push