Skip to main content
Este guia é sua primeira carta no correio: em poucos passos você vai da conta ao primeiro HTTP 202, a confirmação de que a Notifique recebeu seu envio.

​
O que é este guia?

É o caminho mais curto da conta ao primeiro envio. Documentação de dev para dev: direto, sem juridiquês. A Notifique é a infraestrutura de mensagens do seu produto. Filas, retentativas e protocolos ficam do nosso lado; do seu lado, uma API REST previsível.

​
O que você vai conseguir?

Ao terminar este guia:
  • Conta criada no dashboard
  • Chave de API salva (sk_test_ ou sk_live_)
  • Primeira mensagem enfileirada em SMS ou WhatsApp

​
Por onde começar?

Para o primeiro envio, o caminho mais curto costuma ser SMS ou WhatsApp: Outros canais (e-mail, push, Telegram) têm quick starts próprios quando você precisar.

​
Passo a passo

​
1. Crie sua conta

Crie sua conta no Dashboard Complete o onboarding para ter acesso completo ao workspace.

​
2. Crie uma chave de API

No painel, abra Developer → API Keys. Dê um nome, marque os escopos do canal que vai testar e copie na hora.
A chave começa com sk_live_... ou sk_test_.... Depois de fechar o modal, não mostramos o valor completo de novo. Guarde em .env ou no gerenciador de segredos do seu projeto.
  • Produção (sk_live_...): envio real, debita crédito e a mensagem pode chegar no celular
  • Sandbox (sk_test_...): mesmos endpoints, sem entrega real. Confira em Developer → Caixa sandbox
Recomendamos começar com sk_test_.... Mais em Sandbox e Chaves de API.

​
3. Envie a primeira mensagem

Substitua SUA_API_KEY pela chave que você gerou.

​
SMS

Troque o número pelo seu, em formato internacional (ex.: 5511999999999). O texto precisa ter entre 9 e 160 caracteres.
Resposta esperada: HTTP 202 com a mensagem na fila. Com sk_live_, ela segue para a operadora. Com sk_test_, abra Developer → Caixa sandbox para ver o envio simulado. Guia completo: Quick Start SMS.

​
WhatsApp

Você precisa de uma instância pareada e dos escopos whatsapp:instances:create, whatsapp:instances:list e whatsapp:send. Criar instância e obter o QR
Na resposta, use connection.base64 para exibir o QR e escaneie no celular. Quando o status ficar ACTIVE, anote o instance.id. Enviar texto
Resposta esperada: HTTP 202. Com sk_live_ e instância ativa, a mensagem vai para o WhatsApp. Com sk_test_, confira em Developer → Caixa sandbox. Guia completo: Quick Start WhatsApp.

​
Pronto?

Se você chegou até aqui com HTTP 202, a integração básica está funcionando. A carta saiu do seu sistema e entrou na fila da Notifique.

​
Próximos passos

  • Chaves de API: escopos, boas práticas e rotação de chaves
  • Sandbox: testar sem risco antes do go-live
  • Webhooks: receber avisos de entrega no seu servidor
  • Logs: debugar chamadas à API