Interfejs API do przesyłania e-maili

Spis treści

• Biblioteki
• Podstawowy identyfikator URI
• Poświadczenie
• Błędy
• Lokalizacja
• Paginacja
• Konto
  • Utwórz konto
  • Odzyskać konto
  • Zaktualizuj konto
• Domeny
  • Lista domen
  • Utwórz domenę
  • Odzyskaj domenę
  • Sprawdź rekordy domeny
  • Zaktualizuj domenę
  • Usuń domenę
• Zaprasza
  • Zaakceptuj zaproszenie do domeny
  • Utwórz zaproszenie do domeny
  • Usuń zaproszenie do domeny
• Członkowie
  • Zaktualizuj członka domeny
  • Usuń członka domeny
• Skróty
  • Pobierz aliasy domeny
  • Utwórz nowy alias domeny
  • Zaktualizuj alias domeny
  • Usuń alias domeny

Biblioteki

W tej chwili nie wydaliśmy jeszcze żadnych opakowań API, ale planujemy to zrobić w najbliższej przyszłości. Wysłać e-maila doapi@forwardemail.net jeśli chcesz otrzymywać powiadomienia o wydaniu opakowania API określonego języka programowania. W międzyczasie możesz użyć tych zalecanych bibliotek żądań HTTP w swojej aplikacji lub po prostu użyćkędzior jak w poniższych przykładach.

Język	Biblioteka
Rubin	Faraday
Pyton	upraszanie
Jawa	OkHttp
PHP	chlać
JavaScript	superagent
Node.js	superagent
Udać się	netto / http
.NETTO	RestSharp

Podstawowy identyfikator URI

Bieżąca podstawowa ścieżka URI HTTP to:https://api.forwardemail.net. Starsza podstawowa ścieżka URI HTTP zhttps://forwardemail.net:4000 zostanie wycofany 1 stycznia 2021 r.

Poświadczenie

Wszystkie punkty końcowe wymagają twojegobezpłatny klucz API 🎉 ustawić jako wartość „nazwy użytkownika” żądaniaPodstawowa autoryzacja nagłówek. Nie martw się - poniżej podano przykłady, jeśli nie masz pewności, co to jest.

Błędy

Jeśli wystąpią jakiekolwiek błędy, treść odpowiedzi żądania API będzie zawierać szczegółowy komunikat o błędzie. Oprócz ponad dziesięcioletniego doświadczenia w pisaniu interfejsów API i ich dokumentowaniu, zainspirowały mnieStripe's piękna dokumentacja API, kiedy stworzyliśmy naszą 😄.

Kod	Imię
200	ok
400	Zła prośba
401	Nieautoryzowany
403	Zabroniony
404	Nie znaleziono
429	Zbyt dużo próśb
500	Wewnętrzny błąd serwera
501	Nie zaimplementowano
502	zła Brama
503	serwis niedostępny
504	Limit czasu bramki

Lokalizacja

Nasza usługa jest przetłumaczona na ponad 25 różnych języków. Wszystkie komunikaty odpowiedzi API są tłumaczone na ostatnio wykryte ustawienia narodowe użytkownika wysyłającego żądanie API. Możesz to zmienić, przekazując niestandardowyAccept-Language nagłówek. Wypróbuj go, korzystając z menu rozwijanego języka u dołu tej strony.

Paginacja

Jeśli chcesz otrzymywać powiadomienia o dostępności stronicowania, wyślij wiadomość e-mailapi@forwardemail.net.

Konto

Utwórz konto

POST /v1/account

Parametr ciała	wymagany	Rodzaj	Opis
email	tak	Ciąg (e-mail)	Adres e-mail
password	tak	Strunowy	Hasło

Przykładowe zapytanie:

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

Odzyskać konto

GET /v1/account

Przykładowe zapytanie:

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

Example Response:

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

Zaktualizuj konto

PUT /v1/account

Parametr ciała	wymagany	Rodzaj	Opis
email	Nie	Ciąg (e-mail)	Adres e-mail
given_name	Nie	Strunowy	Imię
family_name	Nie	Strunowy	Nazwisko
avatar_url	Nie	Ciąg (URL)	Link do obrazu awatara

Przykładowe zapytanie:

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

Domeny

Lista domen

GET /v1/domains

Parametr Querystring	wymagany	Rodzaj	Opis
name	Nie	Ciąg (obsługiwany RegExp)	Wyszukaj domeny według nazwy
alias	Nie	Ciąg (obsługiwany RegExp)	Wyszukaj domeny według nazwy aliasu
recipient	Nie	Ciąg (obsługiwany RegExp)	Wyszukaj domeny według odbiorcy

Przykładowe zapytanie:

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

Example Response:

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

Utwórz domenę

POST /v1/domains

Parametr ciała	wymagany	Rodzaj	Opis
domain	tak	Ciąg (FQDN lub IP)	W pełni kwalifikowana nazwa domeny („FQDN”) lub adres IP
plan	Nie	Ciąg (wyliczalny)	Typ planu (musi być"free","enhanced_protection"lub"team", domyślnie to"free")
catchall	Nie	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)

Przykładowe zapytanie:

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

Odzyskaj domenę

GET /v1/domains/example.com

Przykładowe zapytanie:

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

Example Response:

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

Sprawdź rekordy domeny

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

Przykładowe zapytanie:

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

Zaktualizuj domenę

PUT /v1/domains/example.com

Parametr ciała	wymagany	Rodzaj	Opis
smtp_port	Nie	Ciąg lub liczba	Niestandardowy port do skonfigurowania do przekazywania SMTP (domyślnie jest to"25")

Przykładowe zapytanie:

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

Example Response:

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

Usuń domenę

DELETE /v1/domains/:domain_name

Przykładowe zapytanie:

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

Zaprasza

Zaakceptuj zaproszenie do domeny

GET /v1/domains/:domain_name/invites

Przykładowe zapytanie:

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

Utwórz zaproszenie do domeny

POST /v1/domains/example.com/invites

Parametr ciała	wymagany	Rodzaj	Opis
email	tak	Ciąg (e-mail)	Adres e-mail do zaproszenia na listę członków domeny
group	tak	Ciąg (wyliczalny)	Grupuj, aby dodać użytkownika do członkostwa w domenie za pomocą (może być jednym z"admin" lub"user")

Przykładowe zapytanie:

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

Usuń zaproszenie do domeny

DELETE /v1/domains/:domain_name/invites

Parametr ciała	wymagany	Rodzaj	Opis
email	tak	Ciąg (e-mail)	Adres e-mail do usunięcia z listy członków domeny

Przykładowe zapytanie:

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

Członkowie

Zaktualizuj członka domeny

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

Parametr ciała	wymagany	Rodzaj	Opis
group	tak	Ciąg (wyliczalny)	Grupa, aby zaktualizować użytkownika do członkostwa w domenie za pomocą (może być jednym z"admin" lub"user")

Przykładowe zapytanie:

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

Usuń członka domeny

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

Przykładowe zapytanie:

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

Skróty

Pobierz aliasy domeny

GET /v1/domains/example.com/aliases

Przykładowe zapytanie:

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

Utwórz nowy alias domeny

POST /v1/domains/example.com/aliases

Parametr ciała	wymagany	Rodzaj	Opis
name	tak	Strunowy	Pseudonim
recipients	tak	Łańcuch lub tablica	Lista adresatów (musi być oddzielona linią / spacją / przecinkiem Ciąg lub tablica prawidłowych adresów e-mail, w pełni kwalifikowanych nazw domen („FQDN”), adresów IP i / lub adresów URL haka internetowego)
description	Nie	Strunowy	Opis aliasu
labels	Nie	Łańcuch lub tablica	Lista etykiet (musi być ciągiem lub tablicą z podziałem wiersza / spacją / przecinkiem)
is_enabled	Nie	Boolean	Określa, czy włączyć tę alias (jeśli wyłączona, wiadomości e-mail nie będą kierowane nigdzie, ale zwracają pomyślne kody stanu)

Przykładowe zapytanie:

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

Zaktualizuj alias domeny

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

Parametr ciała	wymagany	Rodzaj	Opis
name	Nie	Strunowy	Pseudonim
recipients	tak	Łańcuch lub tablica	Lista adresatów (musi być oddzielona linią / spacją / przecinkiem Ciąg lub tablica prawidłowych adresów e-mail, w pełni kwalifikowanych nazw domen („FQDN”), adresów IP i / lub adresów URL haka internetowego)
description	Nie	Strunowy	Opis aliasu
labels	Nie	Łańcuch lub tablica	Lista etykiet (musi być ciągiem lub tablicą z podziałem wiersza / spacją / przecinkiem)
is_enabled	Nie	Boolean	Określa, czy włączyć tę alias (jeśli wyłączona, wiadomości e-mail nie będą kierowane nigdzie, ale zwracają pomyślne kody stanu)

Przykładowe zapytanie:

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

Usuń alias domeny

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

Przykładowe zapytanie:

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