Documentación de la API para desarrolladores

Primeros pasos

Todos los planes de pago incluyen acceso completo a la API REST. Genera una clave en tu cuenta, en Cuenta → Claves de API, y envíala con cada solicitud:

curl -H "X-Api-Key: YOUR_KEY" https://mailflow.top/api/index.php/lists

URL base: https://mailflow.top/api/index.php · Las respuestas son JSON con un campo status con valor success o error. La API no está disponible en el plan gratuito.

Recursos principales

La plataforma es compatible con MailWizz, así que toda la API principal —listas, suscriptores, segmentos, campos personalizados, campañas, seguimiento, plantillas, email transaccional, rebotes y bajas— está documentada de forma interactiva (OpenAPI) en:

→ Referencia interactiva de la API (OpenAPI)

Los SDK de MailWizz existentes (p. ej., el SDK de PHP oficial) funcionan sin configuración adicional: solo tienes que apuntarlos a la URL base indicada arriba.

Endpoints de IA

Las funciones de IA son ciudadanas de primera clase en la API: la misma clave, la misma autenticación y los mismos límites de plan y consumo de créditos que en la aplicación web.

GET /ai/credits

Tu contador de créditos de IA del mes en curso. Los créditos son por mes de facturación y los no utilizados no se acumulan al mes siguiente.

{"status":"success","data":{"unlimited":false,"limit":750,"used":112,"remaining":638}}

GET /ai/replies

Clasificaciones de Smart Replies para tus campañas: alimenta tu CRM con quién está interesado, quién hizo una pregunta y quién se quejó. Filtros: category (interested, question, complaint, unsubscribe_request, auto_reply, out_of_office, bounce, other), campaign_uid, since (YYYY-MM-DD), page, per_page (máx. 50).

curl -H "X-Api-Key: YOUR_KEY" \
  "https://mailflow.top/api/index.php/ai/replies?category=interested&since=2026-08-01"

{"status":"success","data":{"count":42,"current_page":1,"per_page":20,"total_pages":3,
  "records":[{"from_email":"[email protected]","subject":"RE: your offer",
    "category":"interested","confidence":98,"engine":"embeddings",
    "summary":"...","suggested_reply":"...","date_added":"2026-08-24 18:21:19",
    "campaign_uid":"py794hjqk8a8d"}]}}

GET /ai/tiers

Niveles de interacción de IA (vip, engaged, passive, at_risk, dormant) por lista: la misma puntuación que impulsa el piloto automático y la recuperación.

{"status":"success","data":{"records":[
  {"list_uid":"qk661oq7nl8c1","name":"Main list","tiers":{"engaged":1200,"passive":3400,"dormant":900}}]}}

POST /ai/subject-lines

Genera líneas de asunto en cualquier idioma. Cuerpo: topic (obligatorio), count (1–5, 3 por defecto), language (opcional). Consume créditos de IA igual que el editor web.

curl -X POST -H "X-Api-Key: YOUR_KEY" -H "Content-Type: application/json" \
  -d '{"topic":"Summer sale for B2B customers","count":3,"language":"Greek"}' \
  https://mailflow.top/api/index.php/ai/subject-lines

{"status":"success","data":{"subjects":["...","...","..."],"credits_remaining":636}}

GET /ai/flows · POST /ai/flows/author · POST /ai/flows/<uid>/enroll · POST /ai/flows/<uid>/status

El creador de flujos con IA a través de la API: lista tus flujos con contadores en tiempo real; haz que la IA cree un flujo completo a partir de un objetivo en lenguaje natural ({"goal":"...","list_uid":"..."}, que devuelve un borrador que activas con {"status":"active"}); inscribe a un suscriptor en un flujo ({"email":"..."}).

curl -X POST -H "X-Api-Key: YOUR_KEY" -H "Content-Type: application/json" \
  -d '{"goal":"When someone replies interested, notify me, wait 2 days, then send a case study"}' \
  https://mailflow.top/api/index.php/ai/flows/author

Errores y límites

401 — X-Api-Key ausente o no válido
403 — la función no está incluida en tu plan
422 — parámetros ausentes o no válidos
429 — se ha alcanzado el límite de créditos de IA o la asignación mensual de IA; se restablece en tu próxima fecha de facturación

Las ráfagas se limitan por clave: implementa un reintento con espera exponencial (exponential backoff) ante un 429. ¿Tienes preguntas? Contáctanos o abre un ticket de soporte.

API para desarrolladores