API — perguntas frequentes
Respostas rápidas para programadores que integram o Mailpro.
Como obtenho uma chave de API?+
Inicie sessão na sua conta Mailpro e abra Definições → Acesso à API. Encontrará o seu ID de cliente numérico e a sua chave de API (GUID). Pode chamar as APIs diretamente com esses dados, ou trocá-los por um token OAuth 2.0 / Bearer JWT no endpoint de token.
Que métodos de autenticação são suportados?+
Três: OAuth 2.0 com PKCE (recomendado para aplicações de terceiros e plataformas como Zapier, Make e n8n), Bearer JWT (legado) e id_client + chave de API. Um único token OAuth funciona nas APIs de Email, CRM e SMS.
As APIs são REST ou SOAP?+
São APIs REST modernas sobre HTTPS. As respostas são em JSON por predefinição (as APIs de Email e SMS também suportam XML), com recursos previsíveis, verbos HTTP padrão e códigos de estado.
Existe documentação interativa ou um modo de teste?+
Sim. Todos os endpoints podem ser experimentados ao vivo a partir da documentação interativa Swagger, e pode enviar emails e SMS de teste para o seu próprio endereço antes de passar à produção.
Que linguagens e SDKs posso utilizar?+
Qualquer linguagem que fale HTTP e JSON. Publicamos um SDK oficial no GitHub e disponibilizamos exemplos prontos a usar em curl, Node.js, Python, PHP e C#.
As APIs suportam webhooks?+
Sim. Subscreva eventos em tempo real — email entregue, aberto, clicado, devolvido, e relatórios de entrega de SMS — enviados como callbacks HTTP assinados com HMAC-SHA256.
Posso enviar emails transacionais, e não apenas campanhas?+
Sim. Envie um único email para um destinatário com campos personalizados, anexos e agendamento opcional, utilizando a Email API ou a CRM API.
Posso enviar ficheiros anexados? Quais são os limites e o custo?+
Sim — anexe ficheiros ao enviar um email através da Email API (v2) ou da CRM API (v3): até 5 ficheiros, 10 MB por ficheiro e 15 MB no total. Envie-os como anexos codificados em Base64 em qualquer das APIs (a Email API também aceita carregamento de ficheiros multipart/form-data). O custo é de 1 crédito por cada 500 KB de anexos, com os primeiros 500 KB incluídos no crédito base do email (por isso anexos até ~500 KB não acrescentam nada). São aceites os formatos comuns de documentos e imagens; os ficheiros executáveis e de script (.exe, .bat, .js, .vbs, .msi, .jar, .dll, etc.) são bloqueados por segurança.
Como funciona o preço dos SMS?+
Os SMS baseiam-se em créditos. Um SMS custa o preço em créditos do país de destino multiplicado pelo número de partes (uma mensagem longa é dividida em várias partes). O envio de emails utiliza créditos de email.
Que formatos de endereço de email são aceites?+
Qualquer endereço em conformidade com a RFC, incluindo o sub-endereçamento com um "+" (por exemplo [email protected]), que é suportado pelo Gmail, Fastmail, Proton e outros.
Quais são os limites de taxa?+
Os pedidos têm limite de taxa por conta. Quando excede o limite, recebe uma resposta HTTP 429 com cabeçalhos claros, para poder abrandar e repetir de forma controlada.
