Referência da API¶

A API de Email Transacional da InteSys (powered by FrontEngine) é uma API HTTP baseada em JSON com endpoints no estilo RPC. Cada ação possui seu próprio endpoint. Todas as requisições utilizam HTTPS com método POST e parâmetros codificados em JSON.

URL Base: https://app1.frontengine.net

Autenticação¶

Todas as requisições à API requerem o cabeçalho X-Server-API-Key com sua chave de API do servidor.

X-Server-API-Key: your-api-key-here

Obtenha sua chave de API no portal do cliente InteSys ou entre em contato com o suporte.

Erros de Autenticação¶

Formato de Resposta¶

Todas as respostas da API seguem esta estrutura:

{
  "status": "success",
  "time": 0.23,
  "flags": {},
  "data": {}
}

Códigos de Status HTTP¶

API de Envio¶

Enviar Mensagem¶

Envie um email transacional com controle total sobre cabeçalhos, corpo e anexos.

POST /api/v1/send/message

Parâmetros:

*Pelo menos um entre html_body ou plain_body deve ser fornecido.

Objeto de Anexo:

Códigos de Erro:

Exemplo: curl¶

curl -X POST https://app1.frontengine.net/api/v1/send/message \
  -H "X-Server-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "[email protected]",
    "to": ["[email protected]"],
    "subject": "Confirmação do Pedido #12345",
    "html_body": "<h1>Obrigado pelo seu pedido!</h1><p>O pedido #12345 foi confirmado.</p>",
    "plain_body": "Obrigado pelo seu pedido! O pedido #12345 foi confirmado.",
    "tag": "order-confirmation",
    "reply_to": "[email protected]"
  }'

Exemplo: Python¶

import requests

response = requests.post(
    "https://app1.frontengine.net/api/v1/send/message",
    headers={
        "X-Server-API-Key": "your-api-key",
        "Content-Type": "application/json",
    },
    json={
        "from": "[email protected]",
        "to": ["[email protected]"],
        "subject": "Bem-vindo!",
        "html_body": "<h1>Bem-vindo à nossa plataforma!</h1>",
    },
)

print(response.json())

Exemplo: Node.js¶

const response = await fetch(
  "https://app1.frontengine.net/api/v1/send/message",
  {
    method: "POST",
    headers: {
      "X-Server-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      from: "[email protected]",
      to: ["[email protected]"],
      subject: "Bem-vindo!",
      html_body: "<h1>Bem-vindo à nossa plataforma!</h1>",
    }),
  }
);

const data = await response.json();
console.log(data);

Envio Raw (RFC2822)¶

Envie uma mensagem RFC2822 pré-formatada. Útil para aplicações que constroem suas próprias mensagens MIME.

POST /api/v1/send/raw

Parâmetros:

Códigos de Erro:

API de Mensagens¶

Obter Detalhes da Mensagem¶

Recupere detalhes completos sobre uma mensagem enviada.

POST /api/v1/messages/message

Parâmetros:

Códigos de Erro:

Obter Tentativas de Entrega¶

Recupere todas as tentativas de entrega de uma mensagem específica.

POST /api/v1/messages/deliveries

Parâmetros:

Códigos de Erro:

Próximos Passos¶

• Autenticação — Configure SPF, DKIM e DMARC para seu domínio de envio
• Webhooks — Receba notificações de eventos de entrega em tempo real