SDKs oficiales

Para no armar los requests HTTP a mano, Arplyx ofrece SDKs oficiales que envuelven la API con tipos, manejo de errores e idempotencia. Hacen lo mismo que la API REST; elegí el de tu lenguaje.

TypeScript / Node.js — `@arplyx/sdk`

npm install @arplyx/sdk

import { Arplyx, ArplyxError } from '@arplyx/sdk';

const arplyx = new Arplyx({ apiKey: process.env.ARPLYX_API_KEY! });

const msg = await arplyx.sendMessage({
  externalId: 'pedido-10045',
  to: '+5491155551234',
  text: 'Tu pedido fue confirmado.',
  channel: 'whatsapp_direct',
  whatsappAccountId: 'TU_ACCOUNT_ID',
});
console.log(msg.messageId, msg.status);

Funciona con ESM y CommonJS. Requiere Node.js 18+.

Python — `arplyx`

pip install arplyx

from arplyx import Arplyx

client = Arplyx(api_key="ak_live_...")

msg = client.send_message(
    external_id="pedido-10045",
    to="+5491155551234",
    text="Tu pedido fue confirmado.",
    channel="whatsapp_direct",
    whatsapp_account_id="TU_ACCOUNT_ID",
)
print(msg.message_id, msg.status)

Requiere Python 3.8+.

Qué exponen

Ambos SDKs cubren las mismas operaciones que la API:

Operación	TypeScript	Python
Enviar mensaje (texto o plantilla)	`sendMessage(...)`	`send_message(...)`
Enviar broadcast a una lista	`sendBroadcast(...)`	`send_broadcast(...)`
Listar cuentas de WhatsApp	`listWhatsappAccounts()`	`list_whatsapp_accounts()`
Consultar estado de un mensaje	`getMessage(id)`	`get_message(id)`

Manejo de errores

Las respuestas de error de la API se traducen a una excepción tipada ArplyxError, con status (código HTTP) y code (validation_error, conflict, quota_exceeded, etc. — ver Errores y estados).

TypeScriptPython

try {
  await arplyx.sendMessage({ externalId: 'x', to: '+5491155551234', text: 'hola' });
} catch (err) {
  if (err instanceof ArplyxError) {
    console.error(err.status, err.code, err.details);
  }
}

from arplyx import ArplyxError

try:
    client.send_message(external_id="x", to="+5491155551234", text="hola")
except ArplyxError as e:
    print(e.status, e.code, e.details)

API key

Los SDKs se autentican con tu API key (ak_live_…). Generala desde Portal → API Keys — ver Autenticación. Guardala en una variable de entorno, nunca en el código fuente.

¿Usás un agente de IA?

Si querés que un asistente (Claude, Cursor, etc.) use Arplyx directamente, mirá Conectar por MCP.