Перейти к документации
API

Быстрый старт

Ключ и первая отправка.

1. Создайте ключ

  1. Откройте Settings → API keys. Эта страница есть только у владельца почтового ящика.
  2. Назовите ключ по тому, что им будет пользоваться. По этому имени вы найдёте его снова, когда что-то придётся отозвать.
  3. Выберите его скоупы. По умолчанию — только отправка.
  4. При желании сузьте то, от чьего имени он может отправлять: целые домены, отдельные адреса или и то и другое. Целый домен покрывает и адреса, добавленные на него позже.
  5. Скопируйте ключ. Он показывается один раз и не восстанавливается: хранится односторонний хеш. Последующая ротация ключа точно так же показывает замену один раз.

2. Отправьте что-нибудь

npm install @openemail/sdk

Необязательно. Каждый эндпоинт — это обычный HTTP и JSON, а вкладке curl ниже вообще ничего устанавливать не нужно.

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

200 означает, что письмо ушло. В ответ вы получаете id. Сохраните его: по нему вы получите сообщение, прочитаете историю его событий или отмените отправку, если она была запланированной.

Получили неожиданный 403? GET /addresses перечисляет ровно то, от чьего имени этот ключ может отправлять. Почти всегда дело в скоупе отправки у ключа, в домене или адресе, которые ему не выданы, а не в отсутствующем домене у рабочего пространства.