Skip to main content

Referência da API

Bem-vindo à documentação completa da API Arara! Aqui você encontrará todos os detalhes necessários para integrar o envio de mensagens via WhatsApp em sua aplicação.

Visão Geral

A Arara é uma API REST simples e poderosa que permite:
  • Enviar mensagens de template via WhatsApp
  • Gerenciar templates através do dashboard
  • Receber notificações via webhooks
  • Integrar com carrinhos de compra e outros sistemas

Base URL

Todas as requisições devem ser feitas para:
https://api.ararahq.com

Autenticação

Todas as requisições à API requerem autenticação usando uma chave de API (API Key). A chave deve ser incluída no cabeçalho Authorization:
Authorization: Bearer ara_sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Formato de Resposta

A API retorna respostas em formato JSON. Todas as datas e horas são retornadas no formato ISO 8601 (UTC).

Resposta de Sucesso

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "PENDING",
  ...
}

Resposta de Erro

{
  "error": "Bad Request",
  "message": "receiver is required"
}

Códigos de Status HTTP

CódigoDescrição
200Sucesso - Requisição processada com sucesso
202Aceito - Requisição aceita para processamento
400Requisição Inválida - Dados malformados ou faltando
401Não Autorizado - Chave de API inválida ou ausente
404Não Encontrado - Recurso não existe
422Entidade Não Processável - Dados válidos mas não processáveis
500Erro Interno do Servidor - Erro no servidor

Rate Limits

A API possui limites de taxa para garantir a estabilidade do serviço. Limites específicos serão comunicados no dashboard.

Suporte

Precisa de ajuda? Entre em contato: