Soluci贸n de Email Personalizada
Integrando 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 del Operador listados abajo, lo cual permite al Operador gestionar el proveedor de Email. Soporta enviar 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 su procesamiento y responder con las respuestas respectivas.
El formato de la 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 por Webhook o Polling para que los datos de conversi贸n puedan ser almacenados correctamente. Por favor, consulta los ejemplos mostrados y las tablas de abajo para mayor clarificaci贸n.
Pre-Requisitos
- Avisar a Fast Track si alguna 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 alg煤n m谩ximo de lote debe ser tomado en consideraci贸n.
- Proporcionar a Fast Track cualquier credencial espec铆fica para los proveedores integrados (si se requiere)
Email por Lotes
El Email por Lotes ayuda a procesar una colecci贸n de Emails en una sola solicitud a la API. El n煤mero de mensajes dentro de la solicitud por lotes est谩 limitado por una cantidad entera establecida en la configuraci贸n y se env铆a dentro de un per铆odo 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 el env铆o por lotes de Email a trav茅s de la API.
猬嗭笍 POST <operator-api-endpoint-url>/channels/email/batch
Header de la Solicitud
El header de la solicitud enviada contiene una "X-Api-Key" que es un token requerido para autenticar las llamadas de la API en el endpoint. Este token necesita ser pasado a Fast Track para hacer estas solicitudes.
Esquema del Cuerpo de la Solicitud
Aqu铆 hay un ejemplo del formato esperado al agrupar las solicitudes por lotes. Las solicitudes se almacenan 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 煤nico interno 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 acciones del cual se origina el Email en Fast Track |
activity.trigger_hash * | string | Hash del disparador |
activity.action_id * | integer | El identificador 煤nico de la acci贸n individual de Fast Track |
subject * | string | La l铆nea de asunto del Email |
content * | string | El contenido del Email, como HTML |
amp_content | string (opcional) | Versi贸n AMP HTML opcional del cuerpo del email |
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 |
provider_name | string | El proveedor de email para enrutar el mensaje |
meta | object | Pares clave-valor personalizados definidos en la actividad del CRM de Fast Track |
Respuestas Esperadas
Las siguientes respuestas deben ser retornadas por la API del Operador.
Exitosa Respuesta JSON HTTP 200
El "activity.id" enviado inicialmente en la solicitud ser谩 retornado 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, que Fast Track usar谩 para identificar el mensaje de Email relacionado al actualizar su estado.
Si alguna de las categor铆as listadas ("successful", "failed" o "fatal") no tiene un Email asociado, deben ser retornadas 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. Adem谩s, 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 el procesamiento por 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 & X-API-KEY que puedes usar para enviar los datos de conversi贸n para cada Email.
La X-API-KEY suministrada se espera como un header en la solicitud.
Es importante que los datos de "activity" que son proporcionados por Fast Track en la solicitud de Env铆o de 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 acciones del cual se origina el Email en Fast Track |
activity.trigger_hash | string | Hash del disparador |
activity.action_id | integer | El identificador 煤nico de la acci贸n individual de 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 |