Documentação para Desenvolvedores

Referência da API

Nossa API foi projetada para ser simples, rápida e segura, permitindo que você integre envios de mensagens transacionais em minutos.

Endpoint Base

A API de produção está disponível em: https://api.messagecloud.com.br

Autenticação

Para utilizar a nossa API, você precisará de uma Chave de API (API Key). Você pode gerar e gerenciar suas chaves diretamente no seu painel de controle.

x-api-key

Header obrigatório para todas as requisições de envio.

Header	Valor
x-api-key	Sua chave de API (ex: `mc_live_...`)

Envios de E-mail

O envio de e-mails é feito através de Templates. Você pode visualizar os templates disponíveis e seus respectivos slugs no seu dashboard.

POST/messages/send

Campo	Tipo	Descrição
to	string	E-mail do destinatário.
type	string	Deve ser `EMAIL`.
template	string	O `slug` do template.
data	object	Variáveis exigidas pelo template.
fromName	string	(Opcional) Nome do remetente.

Exemplo cURL

Terminalbash

curl -X POST https://api.messagecloud.com.br/messages/send \
  -H "x-api-key: mc_live_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "cliente@exemplo.com",
    "type": "EMAIL",
    "template": "auth-verification-code",
    "data": {
      "code": "123456",
      "name": "João Silva",
      "company_name": "Minha Empresa"
    },
    "fromName": "Suporte"
  }'

Resposta de Sucesso (201)

JSONjson

{
  "success": true,
  "messageId": "msg_abc123...",
  "creditsRemaining": 499
}

Integração SMTP

Se você já possui um sistema que utiliza SMTP, pode utilizar nossas credenciais diretamente:

Host

smtp.messagecloud.com.br

Portas

587 (TLS) ou 465 (SSL)

Usuário / Senha

Sua Chave de API (mc_live_...)

Remetente

notificacoes@seudominio.com

Importante

O domínio utilizado no remetente SMTP deve estar 100% verificado em nosso painel para garantir a entrega das mensagens.

Códigos de Erro

Código	Descrição
BAD_REQUEST	Algum campo obrigatório está faltando ou é inválido.
UNAUTHORIZED	Chave de API inválida ou desativada.
INSUFFICIENT_BALANCE	Você não possui créditos suficientes para este envio.
DOMAIN_NOT_VERIFIED	O domínio de envio ainda não está 100% verificado no DNS.
RESTRICTED_TEMPLATE	Este template exige um plano pago para ser utilizado.

AnteriorConfiguração de DNS

SuporteFalar com Suporte Técnico