Skip to main content

​
Boas-vindas ao Mundo da Comunicação Simplificada!

Este guia rápido vai te mostrar como é fácil integrar a Arara e enviar sua primeira mensagem de template via WhatsApp. Nossa missão é descomplicar, e você verá isso desde o primeiro curl.

​
Objetivo

Siga os passos abaixo para enviar sua primeira mensagem em poucos minutos.

​
Pré-requisitos

Antes de começar, certifique-se de ter:
  • Uma conta na Arara - faça login no Dashboard para criar sua conta automaticamente.
  • Uma Chave de API (ara_sk_***), que você receberá automaticamente ao fazer login pela primeira vez.
  • Um template criado no dashboard (você pode criar um template de teste).
  • Um número de celular verificado para receber as mensagens de teste.
  • Um cliente HTTP (como curl no terminal, Postman, Insomnia ou VS Code com extensão REST Client).
Importante: O número de celular precisa ser cadastrado previamente pela equipe de suporte da Arara, junto com a documentação da empresa. Entre em contato com suporte@ararahq.com para solicitar o cadastro do número.

​
Passo a Passo: Sua Primeira Mensagem

1
Passo 1: Faça Login e Obtenha sua Chave de API
2

Receba sua Chave Única

Acesse o Dashboard da Arara e faça login. Quando você fizer login pela primeira vez, uma chave de API será gerada automaticamente e exibida apenas uma vez.
IMPORTANTE: Guarde sua chave imediatamente! Você não poderá vê-la novamente depois que fechar a tela. A chave terá o formato: ara_sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Sua API Key deve ser tratada como uma senha. Nunca a exponha em código cliente ou repositórios públicos.
3
Passo 2: Crie um Template
4

Crie um Template no Dashboard

No dashboard, navegue até a seção “Templates” e crie um novo template. Por exemplo:
  • Nome: template_teste_inicio_conversa
  • Conteúdo: Olá! Esta é uma mensagem de teste da Arara.
Importante: Você só pode enviar mensagens usando templates que foram criados previamente no dashboard.
5
Passo 3: Faça a Chamada da API
6

Envie a Mensagem com cURL

Abra seu terminal ou cliente HTTP e faça uma requisição POST para o endpoint de envio de mensagens.Substitua:
  • <SUA_API_KEY> pela sua chave de API (ara_sk_***).
  • <NUMERO_DESTINATARIO> pelo número no formato whatsapp:+5583991768778.
  • <NOME_TEMPLATE> pelo nome do template que você criou.
curl -X POST https://api.ararahq.com/v1/messages \
     -H "Authorization: Bearer <SUA_API_KEY>" \
     -H "Content-Type: application/json" \
     -d '{
           "receiver": "whatsapp:+5583991768778",
           "templateName": "template_teste_inicio_conversa",
           "variables": []
         }'
7
Passo 4: Verifique a Resposta
8

Confirme o Envio

Se a requisição for bem-sucedida, você receberá uma resposta 202 Accepted com JSON similar a esta:
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "receiver": "whatsapp:+5583991768778",
  "templateName": "template_teste_inicio_conversa",
  "status": "PENDING",
  "messageType": "TEMPLATE",
  "createdAt": "2024-01-15T10:30:00Z"
}
A mensagem será processada e enviada em breve. Você pode verificar o status e o histórico completo da mensagem no seu Dashboard.

​
Próximos Passos

Agora que você enviou sua primeira mensagem, explore mais:

Crie Seus Templates

Aprenda a criar e gerenciar seus próprios templates de mensagem.

Configure Webhooks

Configure webhooks para receber notificações de eventos, como atualizações de carrinho.

Documentação Completa da API

Explore todos os detalhes do endpoint de envio de mensagens.

Autenticação

Entenda como funciona a autenticação e gerenciamento de chaves.

​
Pronto para Começar

Agora você tem todas as informações necessárias para começar a integrar a Arara em seus projetos. Explore a documentação completa para descobrir todas as funcionalidades disponíveis.