Documentação Maildo

API Maildo

Contrato público de autenticação, paginação, idempotência e operações de workspace implementadas.

Uma API de workspace, não uma chave pública

A API usa a identidade e as permissões verificadas no servidor. Não há serviço de emissão de chaves de API Maildo, endpoint de cobrança, fatura ou saldo de cliente nesta referência. A seleção do workspace não é controlada por um cabeçalho enviado pelo cliente.

Os exemplos são contratos de integração, não chamadas executadas por este site. Faça a autenticação na aplicação, nunca no domínio do site público. A referência foi conferida contra o código revisado, não importada do documento interno de infraestrutura. A versão instalada pode diferir: confirme os endpoints e recursos habilitados no ambiente antes de integrar.

Implementação e disponibilidade são coisas diferentes

Login, cadastro, provisionamento de domínio e transporte de mensagens têm liberações independentes. A presença de um endpoint nesta referência não comprova que ele está habilitado para a sua conta.

O modo de hospedagem SQL sem transporte permite persistência e fluxos autorizados de contatos e templates, mas recusa criação/enfileiramento de campanhas, testes de template e respostas com 503 transport_unavailable. Pausar ou cancelar uma campanha continua sendo uma operação distinta. As ações de provisionar, verificar e submeter um domínio podem responder 503 provisioning_disabled.

Confira acesso e disponibilidade antes de planejar uma integração. Não há garantia de volume diário ou entrega na caixa de entrada.

Como usar esta referência

  1. Leia autenticação antes de chamar uma rota.
  2. Use apenas permissões e dados do workspace autorizado. Não misture cookies e cabeçalhos de autenticação.
  3. Comece pelas consultas. Operações de escrita exigem revisão do corpo, CSRF quando aplicável e idempotência.
  4. Não execute exemplos de importação ou envio com dados fictícios em uma conta real. A finalidade e o consentimento devem corresponder a evidências verdadeiras.