Solução de Email Personalizada
Integrando uma solução/provedor de Email personalizado como parte da sua API do Operador
Fast Tracks suporta uma variedade de provedores de Email, se o seu negócio precisar de um provedor que não faça parte da lista de provedores suportados, então você pode construir esta API.
Serviço de Email Fast Track
O serviço de Email Fast Track pode ser configurado para enviar requisições de Email para os endpoints da API do Operador listados abaixo, que permite ao Operador gerenciar o provedor de Email. Ele suporta o envio de mensagens e obter o status de entrega.
O seguinte endpoint pode ser construído como parte da sua API do Operador:
⬆️ POST /channels/email/batch
O Operador pode então encaminhar essas requisições para o provedor de Email para processamento e responder de volta com as respectivas respostas.
Formato da API e respostas precisam ser formatados conforme descrito abaixo
É importante que os dados "meta" descritos abaixo sejam enviados de volta para o Fast Track via Webhook ou Polling para que os dados de conversão possam ser armazenados corretamente. Por favor, consulte os exemplos mostrados e as tabelas abaixo para esclarecimentos adicionais.
Pré-Requisitos
- Informe o Fast Track se alguma limitação de taxa deve ser levada em consideração. (Se você planeja implementar limitação de taxa, por favor contate o Fast Track antes, para que possamos orientá-lo na implementação suportada)
- Informe o Fast Track se algum máximo de lote deve ser levado em consideração.
- Forneça ao Fast Track quaisquer credenciais específicas para os provedores integrados (se necessário)
Email em Lote
Email em Lote ajuda a processar uma coleção de Emails em uma requisição para a API. O número de mensagens dentro da requisição de lote é limitado por uma quantidade inteira definida na configuração e enviada dentro de um período de tempo configurado, mesmo quando o lote ainda não estiver cheio.
Implementação do Endpoint
Implemente o endpoint no formato abaixo para suportar o envio de Email em lote através da API.
⬆️ POST <operator-api-endpoint-url>/channels/email/batch
Cabeçalho da Requisição
O cabeçalho da requisição enviada contém um "X-Api-Key" que é um token necessário para autenticar as chamadas da API no endpoint. Este token precisa ser passado para o Fast Track para fazer essas requisições.
Schema do Corpo da Requisição
Aqui está um exemplo do formato esperado ao agrupar as requisições em lote. As requisições são armazenadas em um array, uma após a outra.
| Chave | Tipo | Descrição |
|---|---|---|
activity.id * | string | Um identificador único do Email |
activity.brand_id * | integer | O identificador único da marca no Fast Track |
activity.user_id * | string | O identificador único do jogador |
activity.internal_user_id * | integer | O identificador único interno do jogador |
activity.activity_id * | integer | O identificador único da configuração de atividade no Fast Track |
activity.action_group_id * | integer | O identificador único do grupo de ações do qual o Email se origina no Fast Track |
activity.trigger_hash * | string | Hash do gatilho |
activity.action_id * | integer | O identificador único da ação individual do Fast Track |
subject * | string | A linha de assunto do Email |
content * | string | O conteúdo do Email, como HTML |
amp_content | string (opcional) | Versão opcional em AMP HTML do corpo do email |
email * | string | O endereço de email do jogador |
sender_name * | string | O nome do remetente configurado no Fast Track para a conta de email |
sender_address * | string | O endereço do remetente configurado no Fast Track para a conta de email |
replyto_address * | string | O endereço de resposta configurado no Fast Track para a conta de email |
provider_name | string | O provedor de email para rotear a mensagem através dele |
meta | object | Pares chave-valor personalizados definidos na atividade CRM do Fast Track |
Respostas Esperadas
As respostas abaixo devem ser retornadas pela API do Operador.
Resposta JSON HTTP 200 de Sucesso
O "activity.id" inicialmente enviado na requisição será retornado de volta na resposta como "id". Isso é necessário para ajudar o Fast Track a identificar a mensagem de Email individual na requisição de lote inicial.
O "email_id" será um identificador único gerado pela API do Operador, que o Fast Track usará para identificar a mensagem de Email relacionada ao atualizar seu status.
Se alguma das categorias listadas ("successful", "failed" ou "fatal") não tiver um Email associado, elas devem ser retornadas como um array vazio.
A requisição precisa incluir uma das propriedades successful, failed ou fatal
| Categoria de Resposta | Descrição |
|---|---|
successful | Entregue com Sucesso. O Fast Track reconhecerá a mensagem e começará a processar o próximo lote na fila. |
failed | Não Sucesso. Ao receber este erro, o Fast Track pulará a mensagem de Email. Além disso, enviará seus dados para Ações Falhadas, se o serviço estiver habilitado. |
fatal | As mensagens serão tentadas novamente |
Quaisquer outras mensagens que não estejam listadas na resposta serão tentadas novamente.
Resposta JSON de ERRO (resposta não 500)
O Fast Track só suportará Código de Status HTTP 200 em lotes. Toda a requisição de lote será tentada novamente se qualquer outro código de status for recebido com a seguinte resposta.
Dados de Conversão
Suportamos a recuperação de dados de conversão através de webhook.
Webhook
O Fast Track fornecerá uma URL de Webhook & X-API-KEY que você pode enviar os dados de conversão para cada Email.
A X-API-KEY fornecida é esperada como um cabeçalho na requisição.
É importante que os dados de "activity" que são fornecidos pelo Fast Track na requisição de Enviar Email sejam enviados de volta
POST {supplied-url}/operator-api/email/conversion
| Chave | Tipo | Descrição |
|---|---|---|
activity.id | string | Um identificador único do Email |
activity.brand_id | integer | Um identificador único da marca no Fast Track |
activity.user_id | integer | Identificador do jogador |
activity.internal_user_id | integer | Identificador interno do jogador |
activity.activity_id | integer | Identificador da configuração de atividade no Fast Track |
activity.action_group_id | integer | Identificador do grupo de ações do qual o Email se origina no Fast Track |
activity.trigger_hash | string | Hash do gatilho |
activity.action_id | integer | O identificador único da ação individual do Fast Track |
email_id | string | O identificador único do Email |
delivery_status | string | Status de entrega do Email |
| Status (delivery_status) | Descrição |
|---|---|
delivered | Mensagem entregue com sucesso ao destinatário final |
open | Destinatário abriu o email (pixel de rastreamento) |
click | Destinatário clicou em um link no email |
spam | Destinatário marcou a mensagem como spam |
bounce | Mensagem foi rejeitada pelo servidor de email do destinatário |
dropped | Mensagem não foi enviada devido a uma regra de supressão (como hard bounce anteriormente) |
failed | Mensagem falhou ao ser enviada ao destinatário final |