REST API
A sua caixa de correio, em HTTP simples.
Envie, leia e gira o correio a partir do seu próprio código. Cada chave tem apenas os âmbitos que lhe conceder.
Em resumo
O que é uma API de email?
Uma API de email permite que software envie e leia correio por HTTP, e não através de uma aplicação. Uma chave em cada pedido decide em que pode tocar quem chama.
104
operações documentadas
25
domínios inteiros de envio por chave
50
endereços isolados, além desses
Como funciona
Limite cada chave a uma tarefa
Escolha os âmbitos de uma chave e, se quiser, os remetentes que pode usar. Um âmbito em falta ou um remetente fora da lista recebe um 403.
Repita sem enviar duas vezes
Cada envio recebe o seu id msg_ antes de sair seja o que for. Uma repetição com a mesma Idempotency-Key devolve o primeiro resultado.
Rode o segredo, mantenha a chave
Rodar troca apenas o segredo, por isso o id, os âmbitos e o histórico de pedidos continuam. Uma chave revogada recebe revoked_api_key.
Âmbitos que uma chave pode ter
Trinta ao todo. As chaves novas começam com emails:send.
Envie o seu primeiro email
HTTP simples e JSON. Nada para instalar.
curl -X POST https://api.openemail.uk/emails \ -H "Authorization: Bearer $OPENEMAIL_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "from": "Acme Billing <[email protected]>", "to": ["[email protected]"], "subject": "Your September invoice", "html": "<p>Invoice attached.</p>" }'O que recebe
Já no produto
Cada envio tem um id
/events por destinatário, /tracking para aberturas e cliques.
Um 403 explicado
GET /ping mostra os âmbitos da chave e o que a sua função lhe deixou.
Chaves por MCP
O servidor MCP também lista, roda, revoga e ativa chaves.
Boas práticas
Tirar o máximo partido
- 01
Uma chave por serviço
Assim, revogar uma chave divulgada trava uma integração, e não todas.
- 02
Defina uma Idempotency-Key
Derive-a de algo único, como um número de fatura, para que uma repetição devolva o primeiro resultado.
- 03
Restrinja o remetente
Liste apenas os endereços a partir dos quais um serviço envia. Um domínio inteiro abrange os que forem adicionados depois.
Ponto de situação
Convém saber
- Sem endpoint de carregamento
- Os anexos em linha vão em base64, 5 MB no total. Ficheiros maiores vão pelo id de um ficheiro do espaço de trabalho, como ligação de transferência.
- Sem estado devolvido num envio
- GET /emails lista uma mensagem devolvida como enviada. A devolução aparece no destinatário e num webhook email.bounced.
Perguntas
O que mais nos perguntam
Continue a explorar
Combina bem com
Começar
O seu domínio,
o seu correio.
Aponte um domínio para o OpenEmail e leia o correio dele numa caixa de correio construída à volta dele. O plano gratuito inclui um domínio.
