SDK Node.js / TypeScript

npm install @ararahq/sdk

import { NodeSDK } from '@ararahq/sdk';

const sdk = new NodeSDK({
  apiKey: process.env.ARARA_API_KEY!,
  baseUrl: 'https://api.ararahq.com', // opcional, este é o default
  timeout: 10000,                     // opcional, em ms, default 10000
  maxRetries: 3,                      // opcional, default 3
});

const { NodeSDK } = require('@ararahq/sdk');

const sdk = new NodeSDK({ apiKey: process.env.ARARA_API_KEY });

async function main() {
  const orderId = '12345'; // id do evento no seu sistema

  const response = await sdk.messages.send(
    {
      receiver: 'whatsapp:+5511999999999',
      templateName: 'pedido_confirmado',
      templateVariables: ['João', orderId],
    },
    { idempotencyKey: `hello-${orderId}` },
  );

  console.log(response.id);     // ara_msg_...
  console.log(response.status); // status inicial da mensagem
}

main().catch((err) => {
  console.error(err);
  process.exit(1);
});

ARARA_API_KEY=ara_live_... node enviar.js

await sdk.messages.send({
  receiver: 'whatsapp:+5511999999999',
  templateName: 'confirmacao_pedido',
  templateVariables: [
    'https://meusite.com/nota/123.pdf', // header (mídia opcional)
    'João',                              // {{1}}
    'ARA-12345',                         // {{2}}
  ],
});

await sdk.messages.send({
  receiver: 'whatsapp:+5511999999999',
  body: 'Oi! Vi sua dúvida e respondo já já.',
});

await sdk.messages.sendBatch({
  templateName: 'pedido_confirmado',
  messages: [{ receiver: '+5511999999999', variables: ['João', '12345'] }],
});

// Criar
const created = await sdk.templates.create({
  name: 'promo_natal',
  category: 'MARKETING',
  language: 'pt_BR',
  body: 'Oi {{1}}, oferta de Natal: {{2}}% off até {{3}}.',
  samples: { '1': 'João', '2': '30', '3': 'sexta' },
});

// Status de aprovação
const status = await sdk.templates.getStatus(created.id);
console.log(status.status, status.rejectionReason);

// Remover
await sdk.templates.delete(created.id);

const { data, pagination } = await sdk.templates.list({ page: 0, size: 50 });
console.log(data.map((t) => t.name), pagination.totalPages);

import { AraraError } from '@ararahq/sdk';

try {
  await sdk.messages.send({ receiver: 'whatsapp:+5511999999999', templateName: 'confirmacao_pedido' });
} catch (err) {
  if (err instanceof AraraError) {
    console.error(err.statusCode, err.code, err.message, err.details);
    if (err.statusCode === 429) {
      console.log('Tente de novo em', err.retryAfter, 'segundos');
    }
  }
}

await sdk.messages.send(
  { receiver: 'whatsapp:+5511999999999', templateName: 'confirmacao_pedido', templateVariables: ['João'] },
  { idempotencyKey: `confirmacao-${order.id}` }
);

import { WebhookUtils } from '@ararahq/sdk';

function handleWebhook(payload: { event: string }) {
  if (WebhookUtils.isMessageStatusEvent(payload)) {
    console.log(payload.data.status, payload.data.receiver); // delivered, read, failed...
    return;
  }
  if (WebhookUtils.isInboundMessageEvent(payload)) {
    console.log(payload.data.from, payload.data.body);
    return;
  }
  if (WebhookUtils.isRevenueRecoveryEvent(payload)) {
    // cart.abandoned, payment.failed, pix.created, boleto.due
    console.log(payload.event, payload.data.phone);
  }
}

import { createHmac, timingSafeEqual } from 'node:crypto';

const TOLERANCE_SECONDS = 300;

export function isValidAraraSignature(rawBody: string, timestamp: string, signature: string, secret: string): boolean {
  const ts = Number(timestamp);
  if (!Number.isInteger(ts) || Math.abs(Date.now() / 1000 - ts) > TOLERANCE_SECONDS) return false;
  const expected = 'sha256=' + createHmac('sha256', secret).update(`${timestamp}.${rawBody}`).digest('hex');
  const a = Buffer.from(expected);
  const b = Buffer.from(signature);
  return a.length === b.length && timingSafeEqual(a, b);
}
// timestamp = header X-Arara-Timestamp, signature = header X-Arara-Signature

import type {
  SDKConfig,
  SendMessageRequest,
  SendMessageOptions,
  MessageResponse,
  Template,
  CreateTemplateRequest,
  TemplateResponse,
  TemplateStatus,
  PaginatedResponse,
  AraraWebhookEvent,
  MessageStatusWebhookEvent,
  RevenueRecoveryWebhookEvent,
  AbacatePayWebhookEvent,
} from '@ararahq/sdk';