SDK Python

pip install ararahq-sdk

import os
from arara_api_sdk import AraraClient

client = AraraClient(
    api_key=os.environ["ARARA_API_KEY"],  # ou omita: o SDK lê ARARA_API_KEY do ambiente
    base_url="https://api.ararahq.com",   # opcional, este é o default
    timeout=30.0,                         # opcional, em segundos
    max_retries=3,                        # opcional; 0 desliga as retentativas
)

# Fecha as conexões ao sair
with AraraClient() as client:
    ...

from arara_api_sdk import AraraClient
from arara_api_sdk.models.message import SendMessageRequest

with AraraClient() as client:  # lê ARARA_API_KEY do ambiente
    response = client.messages.send(SendMessageRequest(
        receiver="+5511999999999",
        template_name="pedido_confirmado",
        template_variables=["João", "12345"],
    ), idempotency_key="pedido-12345")  # id do pedido no seu sistema

print(response.id)      # ara_msg_...
print(response.status)  # status inicial da mensagem

ARARA_API_KEY=ara_live_... python enviar.py

client.messages.send(SendMessageRequest(
    receiver="+5511999999999",
    template_name="confirmacao_pedido",
    template_variables=[
        "https://meusite.com/nota/123.pdf",  # header (mídia opcional)
        "João",                               # {{1}}
        "ARA-12345",                          # {{2}}
    ],
))

client.messages.send(SendMessageRequest(
    receiver="+5511999999999",
    body="Oi! Vi sua dúvida e respondo já já.",
))

import asyncio
from arara_api_sdk import AraraClient
from arara_api_sdk.models.message import SendMessageRequest

async def main():
    async with AraraClient() as client:
        return await asyncio.gather(*[
            client.messages.send_async(SendMessageRequest(
                receiver=phone,
                template_name="lembrete_aula",
                template_variables=["João"],
            ), idempotency_key=f"lembrete-{phone}")
            for phone in ["+5511999990001", "+5511999990002"]
        ])

results = asyncio.run(main())

from uuid import UUID

template_id = UUID("7f1c2e9a-3b4d-4c5e-8f60-1a2b3c4d5e6f")

page = client.templates.list(name="pedido_confirmado")  # { data, pagination }
print([t.name for t in page.data], page.pagination.total_elements)

status = client.templates.get_status(template_id)
print(status.status, status.rejection_reason)

template = client.templates.get(template_id)
print(template.name, template.provider_status)

client.templates.delete(template_id)

from arara_api_sdk import (
    AraraAuthError,
    AraraError,
    AraraRateLimitError,
    AraraUnprocessableError,
)

try:
    client.messages.send(SendMessageRequest(receiver="+5511999999999", body="oi"))
except AraraUnprocessableError as e:
    print(e.code, e.message)  # ex.: INVALID_RECIPIENT
except AraraRateLimitError as e:
    print(f"Limite atingido, tente em {e.retry_after or 1}s")  # depois das retentativas
except AraraAuthError:
    print("Chave de API inválida, revogada ou expirada")
except AraraError as e:
    print(e.status_code, e.code, e.message, e.details)

client.messages.send(request, idempotency_key=f"pedido-{pedido.id}")

import hashlib
import hmac
import time

TOLERANCE_SECONDS = 300

def is_valid_arara(raw_body: bytes, headers: dict, secret: str) -> bool:
    timestamp = headers.get("X-Arara-Timestamp")
    signature = headers.get("X-Arara-Signature")
    if not isinstance(timestamp, str) or not isinstance(signature, str):
        return False
    if not signature.startswith("sha256=") or not timestamp.isdigit():
        return False
    if abs(time.time() - int(timestamp)) > TOLERANCE_SECONDS:
        return False
    expected = hmac.new(secret.encode(), timestamp.encode() + b"." + raw_body, hashlib.sha256).hexdigest()
    return hmac.compare_digest(expected, signature[len("sha256="):])