API пересылки электронной почты

Библиотеки

На данный момент мы еще не выпустили никаких API-оболочек, но планируем сделать это в ближайшем будущем. Отправить письмо наapi@forwardemail.net если вы хотите получать уведомления о выпуске API-оболочки определенного языка программирования. Между тем, вы можете использовать эти рекомендуемые библиотеки HTTP-запросов в своем приложении или просто использоватьлокон как в приведенных ниже примерах.

язык	Библиотека
Рубин	фарадей
питон	Запросы
Ява	OkHttp
PHP	пропивать
JavaScript	SuperAgent
Node.js	SuperAgent
Идти	нетто / HTTP
.СЕТЬ	RestSharp

Базовый URI

Текущий базовый путь HTTP URI:https://api.forwardemail.net, Устаревший базовый HTTP-путь URIhttps://forwardemail.net:4000 будет объявлено устаревшим 1 января 2021 года.

Аутентификация

Все конечные точки требуют вашегобесплатный ключ API 🎉 быть установленным как значение "username" запросаБазовая авторизация заголовок. Не волнуйтесь - ниже приведены примеры, если вы не уверены, что это такое.

ошибки

Если возникнут какие-либо ошибки, в теле ответа на запрос API будет содержаться подробное сообщение об ошибке. Помимо более чем десятилетнего опыта написания API и их документирования, были вдохновленыStripe-х прекрасная документация по API, когда мы создавали нашу 😄.

Код	имя
200	Хорошо
400	Неверный запрос
401	неразрешенный
403	запрещено
404	не обнаружена
429	Слишком много запросов
500	Внутренняя Ошибка Сервера
501	Не реализована
502	Bad Gateway
503	Сервис недоступен
504	Время ожидания шлюза

Tip: If you receive a 5xx status code (which should not happen), then please contact us at api@forwardemail.net and we will help you to resolve your issue immediately.

локализация

Наш сервис переведен более чем на 25 разных языков. Все ответные сообщения API переводятся в последнюю локаль, обнаруженную пользователем, который сделал запрос API. Вы можете переопределить это, передавая пользовательскийAccept-Language заголовок. Не стесняйтесь попробовать его, используя раскрывающийся список языков внизу этой страницы.

пагинация

Если вы хотите получать уведомления о доступности нумерации страниц, напишитеapi@forwardemail.net,

Счет

создать учетную запись

POST /v1/account

Параметр тела	необходимые	Тип	Описание
`email`	да	Строка (электронная почта)	Адрес электронной почты
`password`	да	строка	пароль

Пример запроса:

curl -X POST https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Example Response:

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Password was invalid."
}

Получить аккаунт

GET /v1/account

Пример запроса:

curl -X GET https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Обновить аккаунт

PUT /v1/account

Параметр тела	необходимые	Тип	Описание
`email`	нет	Строка (электронная почта)	Адрес электронной почты
`given_name`	нет	строка	Имя
`family_name`	нет	строка	Фамилия
`avatar_url`	нет	Строка (URL)	Ссылка на аватар

Пример запроса:

curl -X PUT https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Домены

Tip: Domain endpoints with a domain's name /v1/domains/:domain_name as their path are interchangeable with a domain's ID :domain_id. This means you can refer to the domain by either its name or id value.

Список доменов

GET /v1/domains

Параметр Querystring	необходимые	Тип	Описание
`name`	нет	String (поддерживается RegExp)	Поиск доменов по имени
`alias`	нет	String (поддерживается RegExp)	Поиск доменов по псевдониму
`recipient`	нет	String (поддерживается RegExp)	Поиск доменов по получателю

Пример запроса:

curl -X GET https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Создать домен

POST /v1/domains

Параметр тела	необходимые	Тип	Описание
`domain`	да	Строка (FQDN или IP)	Полное доменное имя («FQDN») или IP-адрес
`plan`	нет	Строка (перечислимая)	Тип плана (должен быть`"free"`,`"enhanced_protection"`, или`"team"`по умолчанию`"free"`)
`catchall`	нет	String (delimited email addresses) or Boolean	Create a default catch-all alias, defaults to `true` (if `true` it will use the API user's email address as a recipient, and if `false` no catch-all will be created). If a String is passed, then it is a delimited list of email addresses to use as recipients (separated by line break, space, and/or comma)

Пример запроса:

curl -X POST https://api.forwardemail.net/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Получить домен

GET /v1/domains/example.com

Пример запроса:

curl -X GET https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Проверить записи домена

GET /v1/domains/example.com/verify-records

Пример запроса:

curl -X GET https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Обновить домен

PUT /v1/domains/example.com

Параметр тела	необходимые	Тип	Описание
`smtp_port`	нет	Строка или номер	Пользовательский порт для настройки пересылки SMTP (по умолчанию`"25"`)

Пример запроса:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Удалить домен

DELETE /v1/domains/:domain_name

Пример запроса:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
  -u API_TOKEN:

Предлагает

Принять приглашение домена

GET /v1/domains/:domain_name/invites

Пример запроса:

curl -X GET https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Создать домен приглашение

POST /v1/domains/example.com/invites

Параметр тела	необходимые	Тип	Описание
`email`	да	Строка (электронная почта)	Адрес электронной почты для приглашения в список участников домена
`group`	да	Строка (перечислимая)	Группа для добавления пользователя в членство в домене (может быть одним из`"admin"` или`"user"`)

Пример запроса:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Удалить приглашение домена

DELETE /v1/domains/:domain_name/invites

Параметр тела	необходимые	Тип	Описание
`email`	да	Строка (электронная почта)	Адрес электронной почты для удаления из списка членов домена

Пример запроса:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

члены

Обновить члена домена

PUT /v1/domains/example.com/members/:member_id

Параметр тела	необходимые	Тип	Описание
`group`	да	Строка (перечислимая)	Группа для обновления пользователя до членства в домене (может быть одним из`"admin"` или`"user"`)

Пример запроса:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Удалить члена домена

DELETE /v1/domains/:domain_name/members/:member_id

Пример запроса:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

Псевдонимы

Получить псевдонимы домена

GET /v1/domains/example.com/aliases

Пример запроса:

curl -X GET https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Создать новый псевдоним домена

POST /v1/domains/example.com/aliases

Параметр тела	необходимые	Тип	Описание
`name`	да	строка	Псевдоним
`recipients`	да	Строка или Массив	Список получателей (должен быть строкой / пробелом / разделенным запятыми строкой или массивом допустимых адресов электронной почты, полными доменными именами («FQDN»), IP-адресами и / или URL-адресами веб-крюка)
`description`	нет	строка	Описание псевдонима
`labels`	нет	Строка или Массив	Список меток (должен быть через строку / пробел / через запятую, String или Array)
`is_enabled`	нет	логический	Включение или отключение этого псевдонима (если этот параметр отключен, электронные письма будут перенаправляться в никуда, но возвращать успешные коды состояния)

Пример запроса:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Обновить псевдоним домена

PUT /v1/domains/example.com/aliases/:alias_id

Параметр тела	необходимые	Тип	Описание
`name`	нет	строка	Псевдоним
`recipients`	да	Строка или Массив	Список получателей (должен быть строкой / пробелом / разделенным запятыми строкой или массивом допустимых адресов электронной почты, полными доменными именами («FQDN»), IP-адресами и / или URL-адресами веб-крюка)
`description`	нет	строка	Описание псевдонима
`labels`	нет	Строка или Массив	Список меток (должен быть через строку / пробел / через запятую, String или Array)
`is_enabled`	нет	логический	Включение или отключение этого псевдонима (если этот параметр отключен, электронные письма будут перенаправляться в никуда, но возвращать успешные коды состояния)

Пример запроса:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

Удалить псевдоним домена

DELETE /v1/domains/:domain_name/aliases/:alias_id

Пример запроса:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

Нужны документы с реальными данными и ключами?

Документация по API

API пересылки электронной почты

Оглавление

Библиотеки

Базовый URI

Аутентификация

ошибки

локализация

пагинация

Счет

создать учетную запись

Получить аккаунт

Обновить аккаунт

Домены

Список доменов

Создать домен

Получить домен

Проверить записи домена

Обновить домен

Удалить домен

Предлагает

Принять приглашение домена

Создать домен приглашение

Удалить приглашение домена

члены

Обновить члена домена

Удалить члена домена

Псевдонимы

Получить псевдонимы домена

Создать новый псевдоним домена

Обновить псевдоним домена

Удалить псевдоним домена