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

Зміст

• Бібліотеки
• Базовий URI
• Аутентифікація
• Помилки
• Локалізація
• Пагинація
• Рахунок
  • Створити рахунок
  • Отримайте рахунок
  • Оновити обліковий запис
• Домени
  • Список доменів
  • Створіть домен
  • Отримайте домен
  • Перевірка записів домену
  • Оновіть домен
  • Видалити домен
• Запрошує
  • Прийняти запрошення домену
  • Створіть запрошення до домену
  • Видалити запрошення домену
• Члени
  • Оновити член домену
  • Видалити члена домену
• Псевдоніми
  • Отримати псевдоніми домену
  • Створіть новий псевдонім домену
  • Оновіть псевдонім домену
  • Видалити псевдонім домену

Бібліотеки

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

Мова	Бібліотека
Рубін	Фарадей
Пітон	запити
Java	OkHttp
PHP	загадка
JavaScript	суперагент
Node.js	суперагент
Іди	net / http
.NET	RestSharp

Базовий URI

Поточний URI шлях для базового протоколу HTTP:https://api.forwardemail.net. Спадковий шлях URI до базового HTTPhttps://forwardemail.net:4000 буде застаріло 1 січня 2021 року.

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

Усі кінцеві точки вимагають вашогобезкоштовний ключ API 🎉 встановлюється як значення "ім'я користувача" запитуОсновна авторизація заголовок. Не хвилюйтесь - нижче наведені приклади, якщо ви не впевнені, що це таке.

Помилки

Якщо виникають помилки, орган відповіді на запит API міститиме докладне повідомлення про помилку. Окрім того, що маю понад десятирічний досвід написання API та документування їх, надихалисяСмуга прекрасна документація API, коли ми створили свою 😄.

Код	Ім'я
200	добре
400	Поганий запит
401	Несанкціоновані
403	Заборонено
404	Не знайдено
429	Занадто багато запитів
500	Внутрішня помилка сервера
501	Не впроваджений
502	Неправильний шлюз
503	сервіс не доступний
504	Тайм-аут шлюзу

Локалізація

Наш сервіс перекладений на понад 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."
}

Домени

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

GET /v1/domains

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

Приклад запиту:

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: