Solución de Email Personalizada
Integración de una solución/proveedor de Email personalizado como parte de tu API de Operador
Fast Tracks soporta una variedad de proveedores de Email, si tu negocio necesita un proveedor que no es parte de la lista de proveedores soportados entonces puedes construir esta API.
Servicio de Email de Fast Track
El servicio de Email de Fast Track puede ser configurado para enviar solicitudes de Email a los endpoints de la API de Operador listados abajo, lo cual permite al Operador gestionar el proveedor de Email. Soporta el envío de mensajes y obtener el estado de entrega.
El siguiente endpoint puede ser construido como parte de tu API de Operador:
⬆️ POST /channels/email/batch
El Operador puede entonces reenviar estas solicitudes al proveedor de Email para procesamiento y responder con las respuestas respectivas.
El formato de API y las respuestas necesitan ser formateadas como se describe abajo
Es importante que los datos "meta" descritos abajo sean enviados de vuelta a Fast Track ya sea en Webhook o Polling para que los datos de conversión puedan ser almacenados correctamente. Por favor refiérete a los ejemplos mostrados y las tablas debajo para mayor clarificación.
Pre-Requisitos
- Avisar a Fast Track si cualquier limitación de tasa debe ser tomada en consideración. (Si planeas implementar limitación de tasa por favor contacta a Fast Track antes, para que podamos guiarte en la implementación soportada)
- Avisar a Fast Track si cualquier máximo de lote debe ser tomado en consideración.
- Proporcionar a Fast Track con cualquier credencial específica para los proveedores integrados (si se requiere)
Email por Lotes
Email por Lotes ayuda a procesar una colección de Email en una solicitud a la API. El número de mensajes dentro de la solicitud de lote está limitado por una cantidad entera fija en la configuración y enviado dentro de un lapso de tiempo configurado, incluso cuando el lote aún no está lleno.
Implementación del Endpoint
Implementa el endpoint en el formato de abajo para soportar envío de Email por lotes a través de API.
⬆️ POST <operator-api-endpoint-url>/channels/email/batch
Encabezado de Solicitud
El encabezado de la solicitud enviada contiene un "X-Api-Key" que es un token requerido para autenticar las llamadas a la API en el endpoint. Este token necesita ser pasado a Fast Track para hacer estas solicitudes.
Esquema del Cuerpo de Solicitud
Aquí hay un ejemplo del formato esperado cuando se agrupan las solicitudes por lotes. Las solicitudes son almacenadas en un array, una tras otra.
| Clave | Tipo | Descripción |
|---|---|---|
activity.id | string | Un identificador único del Email |
activity.brand_id | integer | El identificador único de la marca en Fast Track |
activity.user_id | string | El identificador único del jugador |
activity.internal_user_id | integer | El identificador interno único del jugador |
activity.activity_id | integer | El identificador único de la configuración de actividad en Fast Track |
activity.action_group_id | integer | El identificador único del grupo de acción del cual el Email se origina desde Fast Track |
activity.trigger_hash | string | Hash del disparador |
activity.action_id | integer | El identificador único de la acción individual desde Fast Track |
subject | string | La línea de asunto del Email |
content | string | El contenido del Email, como HTML |
amp_content | string (opcional) | El contenido del Email, como AMP |
email | string | La dirección de email del jugador |
sender_name | string | El nombre del remitente configurado en Fast Track para la cuenta de email |
sender_address | string | La dirección del remitente configurada en Fast Track para la cuenta de email |
replyto_address | string | La dirección de respuesta configurada en Fast Track para la cuenta de email |
Respuestas Esperadas
Las siguientes respuestas deben ser devueltas por la API del Operador.
Exitosa Respuesta JSON HTTP 200
El "activity.id" inicialmente enviado en la solicitud será devuelto en la respuesta como "id". Esto es requerido para ayudar a Fast Track a identificar el mensaje de Email individual en la solicitud de lote inicial.
El "email_id" será un identificador único generado por la API del Operador, el cual Fast Track usará para identificar el mensaje de Email relacionado cuando actualice su estado.
Si cualquiera de las categorías listadas ("successful", "failed" o "fatal") no tienen un Email asociado, deben ser devueltas como un array vacío.
La solicitud necesita incluir una de las propiedades successful, failed o fatal
| Categoría de Respuesta | Descripción |
|---|---|
successful | Entregado Exitosamente. Fast Track reconocerá el mensaje y comenzará a procesar el siguiente lote en la cola. |
failed | No Exitoso. Al recibir este error, Fast Track omitirá el mensaje de Email. Adicionalmente, enviará sus datos a Acciones Fallidas, si el servicio está habilitado. |
fatal | Los mensajes serán reintentados |
Cualquier otro mensaje que no esté listado dentro de la respuesta será reintentado.
ERROR (respuesta no 500) Respuesta JSON
Fast Track solo soportará Código de Estado HTTP 200 en lotes. Toda la solicitud de lote será reintentada si cualquier otro código de estado es recibido con la siguiente respuesta.
Datos de Conversión
Soportamos la recuperación de datos de conversión a través de webhook.
Webhook
Fast Track proporcionará una URL de Webhook y X-API-KEY que puedes usar para enviar los datos de conversión para cada Email.
El X-API-KEY suministrado se espera como un encabezado en la solicitud.
Es importante que los datos de "activity" que son proporcionados desde Fast Track en la solicitud de Enviar Email sean enviados de vuelta
POST {supplied-url}/operator-api/email/conversion
| Clave | Tipo | Descripción |
|---|---|---|
activity.id | string | Un identificador único del Email |
activity.brand_id | integer | Un identificador único de la marca en Fast Track |
activity.user_id | integer | Identificador del jugador |
activity.internal_user_id | integer | Identificador interno del jugador |
activity.activity_id | integer | Identificador de la configuración de actividad en Fast Track |
activity.action_group_id | integer | Identificador del grupo de acción del cual el Email se origina en Fast Track |
activity.trigger_hash | string | Hash del disparador |
activity.action_id | integer | El identificador único de la acción individual desde Fast Track |
email_id | string | El identificador único del Email |
delivery_status | string | Estado de entrega del Email |
| Estado (delivery_status) | Descripción |
|---|---|
delivered | Mensaje entregado exitosamente al receptor final |
open | El destinatario ha abierto el email (pixel de seguimiento) |
click | El destinatario ha hecho clic en un enlace en el email |
spam | El destinatario marcó el mensaje como spam |
bounce | El mensaje fue rechazado por el servidor de correo del destinatario |
dropped | El mensaje no fue enviado debido a una regla de supresión (como rebote duro previo) |
failed | El mensaje falló al ser enviado al receptor final |