Saltar para a documentação
API

Início rápido

Uma chave e um primeiro envio.

1. Criar uma chave

  1. Abra Definições → Chaves de API. A página só lá está se for o dono da caixa de correio.
  2. Dê-lhe o nome daquilo que a vai usar. Esse nome é como a volta a encontrar quando for preciso revogar alguma coisa.
  3. Escolha os seus âmbitos. Apenas envio, por omissão.
  4. Opcionalmente, restrinja os remetentes que pode usar: domínios inteiros, endereços individuais, ou ambos. Um domínio inteiro cobre os endereços que lhe forem acrescentados mais tarde.
  5. Copie a chave. É mostrada uma vez e não é recuperável: o que fica guardado é um hash unidirecional. Rodar a chave mais tarde mostra a substituta uma vez, da mesma maneira.

2. Enviar alguma coisa

npm install @openemail/sdk

Opcional. Todos os endpoints são HTTP e JSON simples, e o separador curl abaixo não precisa de nada instalado.

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>"  }'

Um 200 significa que já saiu. Recebe de volta um id. Guarde-o: é como obtém a mensagem, lê o seu rasto de eventos, ou a cancela se a tiver agendado.

Está a receber um 403 que não esperava? GET /addresses lista exatamente os remetentes que esta chave pode usar. É quase sempre o âmbito de envio da chave, um domínio ou um endereço que não lhe foi dado, e não um domínio em falta no espaço de trabalho.