Skip to main content

​
Autenticação

Todas as requisições à Arara requerem autenticação usando uma chave de API (API Key). Esta chave identifica você e autoriza o acesso aos recursos da sua conta.

​
Como Obter Sua Chave de API

​
Passo 1: Faça Login no Dashboard

Acesse o Dashboard da Arara e faça login usando sua conta. Se você ainda não tem uma conta, será criada automaticamente no primeiro login.

​
Passo 2: Receba Sua Chave Única

IMPORTANTE: Quando você faz login pela primeira vez, uma chave de API é gerada automaticamente e exibida apenas uma vez.Guarde esta chave imediatamente em um local seguro! Você não poderá vê-la novamente depois que fechar a tela.
Após o login, você verá uma tela mostrando sua chave de API no formato: 
ara_sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

​
Segurança da Chave

Sua chave de API é como uma senha. Nunca a compartilhe publicamente, não a commite em repositórios Git, e não a exponha em código cliente (frontend JavaScript, apps mobile, etc).

​
Passo 3: Usar a Chave nas Requisições

Inclua sua chave de API no cabeçalho Authorization de todas as requisições: 
Authorization: Bearer ara_sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

​
Exemplo de Requisição Autenticada

Aqui está um exemplo completo de como fazer uma requisição autenticada: 
curl -X POST https://api.ararahq.com/v1/messages \
  -H "Authorization: Bearer ara_sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "receiver": "whatsapp:+5583991768778",
    "templateName": "template_teste_inicio_conversa",
    "variables": []
  }'

​
Gerar Novas Chaves

Se você perdeu sua chave ou precisa de uma nova, você pode gerar uma nova chave de API diretamente no dashboard, na seção “Chaves de API”.
Você pode ter múltiplas chaves de API ativas ao mesmo tempo. Isso é útil para diferentes ambientes (desenvolvimento, produção) ou diferentes aplicações.

​
Revogar Chaves

Se uma chave foi comprometida ou não é mais necessária, você pode revogá-la no dashboard. Uma vez revogada, a chave não poderá mais ser usada para autenticar requisições.

​
Resposta de Erro de Autenticação

Se você usar uma chave inválida ou expirada, receberá uma resposta 401 Unauthorized: 
{
  "error": "Unauthorized",
  "message": "Invalid or expired API key"
}

​
Próximos Passos

Agora que você tem sua chave de API, você está pronto para:

Enviar Mensagens

Aprenda a enviar mensagens de template

Criar Templates

Saiba como criar templates no dashboard