Потрібні документи з реальними даними та ключами?

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

Ви погоджуєтеся з нашою Політикою конфіденційності та Умовами .

Не зацікавлений? Натисніть тут, щоб продовжити читання

Зміст

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

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

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

API переадресації електронної пошти

Зміст

Бібліотеки

Зараз ми ще не випустили жодної оболонки API, але плануємо зробити це найближчим часом. Надіслати електронний лист до api@forwardemail.net якщо ви хочете отримувати сповіщення, коли буде випущено оболонку API певної мови програмування. Тим часом ви можете використовувати ці рекомендовані бібліотеки запитів HTTP у своїй програмі або просто використовувати завиток як у наведених нижче прикладах.

МоваБібліотека
РубінФарадей
Пітонзапити
JavaOkHttp
PHPзагадка
JavaScriptсуперагент
Node.jsсуперагент
Ідиnet / 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

Параметр запитіввимагаєтьсяТипОпис
nameНіРядок (підтримується RegExp)Шукайте домени за назвою
aliasНіРядок (підтримується RegExp)Шукайте домени за псевдонімом
recipientНіРядок (підтримується 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НіБулеваУвімкнути захист вмісту для дорослих у Сканері спаму в цьому домені
has_phishing_protectionНіБулеваУвімкнути захист від фішингу в сканері спаму в цьому домені
has_executable_protectionНіБулеваУвімкнути захист виконуваних файлів сканера спаму в цьому домені
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НіБулеваУвімкнути захист вмісту для дорослих у Сканері спаму в цьому домені
has_phishing_protectionНіБулеваУвімкнути захист від фішингу в сканері спаму в цьому домені
has_executable_protectionНіБулеваУвімкнути захист виконуваних файлів сканера спаму в цьому домені
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

Параметр запитіввимагаєтьсяТипОпис
nameНіРядок (підтримується RegExp)Шукайте псевдоніми в домені за іменем
recipientНіРядок (підтримується 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: