Voltar ao Dashboard
Mailifica API Docs

Documentação da API Mailifica

Explore e integre a infraestrutura de envio transacional de e-mails da Mailifica com suporte a SDKs, webhooks em tempo real e verificação DNS via Cloudflare.

Autenticação

A Mailifica utiliza dois métodos de autenticação: JWT Tokens para o dashboard e API Keys de alta performance (`ma_...`) para o seu servidor.

POST/v1/emails
Autenticação via API Key (Servidor)

Passe a sua chave secreta gerada no dashboard no cabeçalho HTTP Authorization.

Exemplo de Requisição
curl -X POST "http://localhost:8081/v1/emails" \
  -H "Authorization: Bearer ma_123456789abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "contato@cclickangola.com",
    "to": "destinatario@exemplo.com",
    "subject": "Boas-vindas!",
    "html": "<p>Olá do servidor!</p>"
  }'

Enviar E-mails

Endpoints para envio transacional individual e em lote (Batch). Suporta HTML, texto simples e headers customizados.

POST/v1/emails
Enviar E-mail Transacional (Single)

Submete um e-mail para processamento e entrega assíncrona imediata.

Exemplo de Requisição
import { Mailifica } from 'mailifica';

const mailifica = new Mailifica('ma_123456789abcdef');

const data = await mailifica.emails.send({
  from: 'suporte@cclickangola.com',
  to: 'cliente@exemplo.com',
  subject: 'Confirmação de Pedido #1092',
  html: '<h1>Seu pedido foi confirmado!</h1>',
});

console.log('Email ID:', data.id);
POST/v1/emails/batch
Enviar E-mails em Lote (Batch)

Permite submeter até 50 e-mails numa única requisição HTTP.

Exemplo de Requisição
from mailifica import Mailifica

mailifica = Mailifica("ma_123456789abcdef")

batch = mailifica.emails.send_batch([
    {
        "from": "onboarding@cclickangola.com",
        "to": "user1@exemplo.com",
        "subject": "Boas-vindas User 1",
        "html": "<p>Olá User 1!</p>"
    },
    {
        "from": "onboarding@cclickangola.com",
        "to": "user2@exemplo.com",
        "subject": "Boas-vindas User 2",
        "html": "<p>Olá User 2!</p>"
    }
])
GET/v1/emails/{emailID}
Consultar Status do E-mail

Retorna os detalhes e o estado de entrega (Queued, Sent, Delivered, Bounced) de um e-mail específico.

Exemplo de Requisição
curl -X GET "http://localhost:8081/v1/emails/9b1deb4d-3b7d-4146-993c-123456789abc" \
  -H "Authorization: Bearer ma_123456789abcdef"

Domínios & DNS

Gestão de domínios remetentes, geração automática de registros SPF, DKIM, DMARC e MX, e sincronização 1-click via Cloudflare OAuth.

POST/v1/organizations/{orgID}/domains
Adicionar Domínio Remetente

Registra um novo domínio no workspace e calcula todas as chaves DNS necessárias.

Exemplo de Requisição
curl -X POST "http://localhost:8081/v1/organizations/{orgID}/domains" \
  -H "Authorization: Bearer {JWT_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{ "name": "mail.suaempresa.com" }'
POST/v1/organizations/{orgID}/domains/{domainID}/dns/sync
Sincronizar Registros com Cloudflare

Insere instantaneamente os registros DNS gerados na sua zona da Cloudflare via OAuth.

Exemplo de Requisição
curl -X POST "http://localhost:8081/v1/organizations/{orgID}/domains/{domainID}/dns/sync" \
  -H "Authorization: Bearer {JWT_TOKEN}"
POST/v1/organizations/{orgID}/domains/{domainID}/verify
Verificar Propagação DNS

Consulta a rede DNS pública para validar se os registros SPF e DKIM estão ativos.

Exemplo de Requisição
curl -X POST "http://localhost:8081/v1/organizations/{orgID}/domains/{domainID}/verify" \
  -H "Authorization: Bearer {JWT_TOKEN}"

API Keys

Gestão de chaves secretas da organização para acesso via backend.

POST/v1/organizations/{orgID}/api-keys
Criar Nova API Key

Gera uma nova chave com prefixo `ma_`. O token completo é retornado uma única vez.

Exemplo de Requisição
curl -X POST "http://localhost:8081/v1/organizations/{orgID}/api-keys" \
  -H "Authorization: Bearer {JWT_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Servidor de Produção" }'
DELETE/v1/organizations/{orgID}/api-keys/{keyID}
Revogar API Key

Revoga imediatamente o acesso de uma chave de API.

Exemplo de Requisição
curl -X DELETE "http://localhost:8081/v1/organizations/{orgID}/api-keys/{keyID}" \
  -H "Authorization: Bearer {JWT_TOKEN}"