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

Просто зарегистрируйтесь или войдите в систему, чтобы ваши ключи API и данные реального аккаунта были заполнены ниже.

Вы соглашаетесь с нашей Политикой конфиденциальности и Условиями .

Не интересно? Нажмите здесь, чтобы продолжить чтение

Оглавление

Мы создали API для программного доступа к доменам, псевдонимам и многому другому.

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

Программный доступ к вашим данным

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

Оглавление

Библиотеки

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

языкБиблиотека
Рубинфарадей
питонЗапросы
ЯваOkHttp
PHPпропивать
JavaScriptSuperAgent
Node.jsSuperAgent
Идтинетто / HTTP
.NETRestSharp

Базовый URI

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

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

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

ошибки

Если возникают какие-либо ошибки, тело ответа на запрос API будет содержать подробное сообщение об ошибке.

Кодимя
200OK
400Неверный запрос
401неразрешенный
403запрещено
404не обнаружена
429Слишком много запросов
500Внутренняя Ошибка Сервера
501Не реализована
502Плохой шлюз
503Сервис недоступен
504Время ожидания шлюза
Подсказка: Если вы получили код состояния 5xx (чего быть не должно), свяжитесь с нами по адресу api@forwardemail.net и мы поможем вам решить вашу проблему немедленно.

локализация

Наш сервис переведен более чем на 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"

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

GET /v1/account

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

curl -X GET https://api.forwardemail.net/v1/account \
  -u 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"

Домены

Подсказка: Конечные точки домена с именем домена /v1/domains/:domain_name поскольку их путь взаимозаменяем с идентификатором домена :domain_id. Это означает, что вы можете ссылаться на домен либо по его name или id ценность.

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

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:

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

POST /v1/domains

Параметр теланеобходимыеТипОписание
domainдаСтрока (FQDN или IP)Полное доменное имя («FQDN») или IP-адрес
planнетСтрока (перечислимая)Тип плана (должен быть "free", "enhanced_protection", или же "team", по умолчанию "free" или текущий платный план пользователя, если он есть)
catchallнетСтрока (адреса электронной почты с разделителями) или логическое значениеСоздайте универсальный псевдоним по умолчанию, по умолчанию true (если true он будет использовать адрес электронной почты пользователя API в качестве получателя, и если false универсального не будет). Если передается строка, то это список адресов электронной почты с разделителями для использования в качестве получателей (разделенных разрывом строки, пробелом и/или запятой).
has_adult_content_protectionнетлогическийВключить ли защиту содержимого для взрослых с помощью Spam Scanner в этом домене
has_phishing_protectionнетлогическийВключить ли защиту от фишинга Spam Scanner в этом домене
has_executable_protectionнетлогическийВключить ли защиту исполняемого файла Spam Scanner в этом домене
has_virus_protectionнетлогическийВключить ли защиту от вирусов Spam Scanner в этом домене
has_recipient_verificationнетлогическийГлобальный домен по умолчанию для того, чтобы требовать, чтобы получатели псевдонимов щелкали ссылку подтверждения электронной почты для прохождения электронных писем.

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

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

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

GET /v1/domains/example.com

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

curl -X GET https://api.forwardemail.net/v1/domains/example.com \
  -u 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:

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

PUT /v1/domains/example.com

Параметр теланеобходимыеТипОписание
smtp_portнетСтрока или номерПользовательский порт для настройки переадресации SMTP (по умолчанию "25")
has_adult_content_protectionнетлогическийВключить ли защиту содержимого для взрослых с помощью Spam Scanner в этом домене
has_phishing_protectionнетлогическийВключить ли защиту от фишинга Spam Scanner в этом домене
has_executable_protectionнетлогическийВключить ли защиту исполняемого файла Spam Scanner в этом домене
has_virus_protectionнетлогическийВключить ли защиту от вирусов Spam Scanner в этом домене
has_recipient_verificationнетлогическийГлобальный домен по умолчанию для того, чтобы требовать, чтобы получатели псевдонимов щелкали ссылку подтверждения электронной почты для прохождения электронных писем.

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

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u 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

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

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

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

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

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

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

POST /v1/domains/example.com/aliases

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

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

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

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

Вы можете получить псевдоним домена либо по его id или его name ценность.

GET /v1/domains/:domain_name/aliases/:alias_id

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

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

GET /v1/domains/:domain_name/aliases/:alias_name

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

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

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

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

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