Documentación de la API

POST /screenshots

Genera capturas para un correo HTML.

Los resultados de la API de capturas solo son accesibles mediante la API y no aparecen en tu cuenta de preflight.qa.

Todos los parámetros son obligatorios salvo que se indiquen como opcionales.

Parámetro	Descripción
subject Obligatorio	El asunto del correo. Algunas capturas completas también mostrarán esta línea de asunto.
html Obligatorio	El contenido HTML que se renderizará en las aplicaciones de correo.
webhook Opcional	Si se proporciona, enviamos actualizaciones POST a este endpoint a medida que se procesan las capturas. Si no se proporciona, puedes obtener los resultados después con el uuid desde GET /screenshots/:uuid.
apps Opcional	Apps de correo y modos que quieres capturar. Si no se proporciona, probamos contra todos los clientes disponibles.

Ejemplo de solicitud:

curl -X POST "https://api.preflight.qa/screenshots" \
  -H "Authorization: Bearer <api_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "webhook": "https://partner.com/webhook",
    "subject": "My email subject line."
    "html": "<html>...</html>",
    "apps": {
      "apple_mail_mac": { "modes": ["light", "dark"] },
      "outlook_mac": { "modes": ["light", "dark"] }
    }
  }'

Ejemplo de respuesta OK - HTTP 202:

{
  "meta":{
    "uuid": "1b153496-f702-4f89-85b4-cd1a9516cbbe",
    "status": "accepted",
    "code": 202
  }
}

Ejemplo de error - respuesta HTTP 4xx:

{
  "error":{
    "status": "Bad Request",
    "code": 400,
    "message": "No HTML supplied."
  }
}