Documentación de la API

Integra WhatsApp, SMS y Email en minutos

APIs REST v4 simples, documentadas y listas para producción. JWT Auth, webhooks, envío masivo y mucho más.

  • Autenticación JWT Bearer segura
  • Webhooks en tiempo real para todos los eventos
  • Sandbox gratuito, sin tarjeta de crédito
  • Documentación OpenAPI 3.0 completa
Inicio rápido

Integra en 3 pasos

De cero a mensajes enviados en menos de 10 minutos.

1

Obtén tu token

Llama al endpoint de autenticación con tus credenciales para obtener un token JWT que usarás en todas las solicitudes posteriores.

POST /api/v4/auth/token
{"username":"...","password":"..."}
→ {"token": "eyJh..."}
2

Envía tu primer mensaje

Usa el token en el encabezado Authorization y llama al endpoint para enviar un mensaje de WhatsApp, SMS o Email.

POST /whatsapp/chats/{id}/message
Authorization: Bearer <token>
→ {"status": "sent"}
3

Recibe eventos

Configura un webhook para recibir mensajes entrantes, confirmaciones de entrega y actualizaciones de estado en tiempo real.

POST /api/v4/webhooks/create
"url": "https://your-app.com/hook"
→ {"status": "active"}
Seguridad

Autenticación JWT Bearer

Todas las APIs de Chat API usan tokens JWT. Genera tu token con una sola llamada POST e inclúyelo en el encabezado Authorization de cada solicitud.

Caducidad configurable

Los tokens caducan después de un periodo configurable. Regéneralos automáticamente via API sin interrupciones.

HTTPS obligatorio

Todas las comunicaciones se realizan sobre HTTPS con TLS 1.2+. No se aceptan llamadas en texto plano.

Credenciales seguras

El nombre de usuario y la contraseña se intercambian una sola vez para obtener el token usado en las llamadas a la API.

POST /api/v4/auth/token
{
  "username": "your@email.com",
  "password": "your-password"
}
200 OK Response
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...",
  "expiresIn": 3600,
  "type": "Bearer"
}
Usa el token en cada solicitud
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...
Endpoints

Todos los endpoints disponibles

Cada endpoint está documentado con parámetros, respuestas y ejemplos en nuestra documentación OpenAPI.

WhatsApp
POST

Enviar mensaje

/api/v4/whatsapp/chats/{id}/message

Envía un mensaje directo de WhatsApp

GET

Listar plantillas

/api/v4/notifications/whatsapp/templates

Consulta las plantillas de WhatsApp aprobadas

POST

Notificación de plantilla

/api/v4/whatsapp/notifications

Envía una notificación individual fuera de la ventana de 24h

POST

Envío masivo

/api/v4/whatsapp/bulk

Envía a miles de contactos en un solo lote

SMS
POST

Enviar SMS

/api/v4/sms/send

Envía un SMS a cualquier número del mundo

POST

Campaña SMS

/api/v4/sms/bulk

Envío masivo a listas de contactos

GET

Informe de entrega

/api/v4/sms/reports/{id}

Comprueba el estado de entrega

Email
POST

Enviar correo

/api/v4/email/send

Correo transaccional con DKIM/SPF

POST

Campaña de correo

/api/v4/email/bulk

Envía campañas de marketing en masa

GET

Eventos de correo

/api/v4/email/events

Tasa de apertura, clics, rebotes, cancelaciones

Sistema
POST

Autenticación

/api/v4/auth/token

Genera token JWT Bearer

POST

Webhooks

/api/v4/webhooks/create

Configura la recepción de eventos en tiempo real

POST

Chat Widget

/api/v4/iframes/whatsapp/chat-box

Genera un iframe para el chat de WhatsApp

Ejemplos de código

Integra en tu lenguaje

Ejemplos listos para usar para autenticarte y enviar tu primer mensaje.

cURL
curl -X POST \
  https://app.roxpay.eu/api/v4/auth/token \
  -H "Content-Type: application/json" \
  -d '{"username":"...","password":"..."}'

# Use the token:
curl -X POST \
  .../whatsapp/chats/123/message \
  -H "Authorization: Bearer <token>" \
  -d '{"body":"Hello!"}'
Python
import requests

# Authentication
r = requests.post(
  "https://app.roxpay.eu/api/v4/auth/token",
  json={"username":"...", "password":"..."}
)
token = r.json()["token"]

# Send message
requests.post(
  "...whatsapp/chats/123/message",
  headers={"Authorization": f"Bearer {token}"},
  json={"body": "Hello!"}
)
Node.js
// Authentication
const r = await fetch(
  "https://app.roxpay.eu/api/v4/auth/token",
  { method: "POST",
    headers: {"Content-Type":"application/json"},
    body: JSON.stringify({username,password}) }
);
const { token } = await r.json();

// Send message
await fetch("...chats/123/message", {
  method: "POST",
  headers: { Authorization: `Bearer ${token}` },
  body: JSON.stringify({ body: "Hello!" })
});
Entornos

Sandbox y producción

Prueba libremente en el entorno sandbox sin coste, luego cambia a producción con un solo cambio de URL. Sin refactorización.

Sandbox gratuito

Sin consumo de créditos. Mensajes simulados. Pruebas ilimitadas sin configuración adicional.

Producción escalable

Infraestructura empresarial con SLA del 99,9% y soporte técnico dedicado.

Cambio instantáneo

Cambia solo la URL base para pasar de sandbox a producción. El mismo código, el mismo contrato de API.

Sandbox

URL base

https://sandbox.roxpay.eu

✓ Mensajes simulados  ·  ✓ Sin coste  ·  ✓ Datos de prueba

Producción

URL base

https://app.roxpay.eu

✓ Mensajes reales  ·  ✓ SLA 99,9%  ·  ✓ Soporte dedicado

OpenAPI 3.0 - Swagger UI

Documentación completa disponible

Todos los parámetros, esquemas de respuesta, códigos de error y ejemplos interactivos en la interfaz Swagger.