Potrzebujesz dokumentów z prawdziwymi danymi i kluczami?

Po prostu zarejestruj się lub zaloguj, aby wypełnić klucze API i dane konta rzeczywistego poniżej.

Zgadzasz się z naszą Polityką Prywatności i Warunkami .

Nie zainteresowany? Kliknij tutaj, aby kontynuować czytanie

Spis treści

Stworzyliśmy interfejs API do programowego dostępu do domen, aliasów i innych elementów.

Dokumentacja API

Programowy dostęp do twoich danych

Interfejs API do przesyłania e-maili

Spis treści

Biblioteki

W tej chwili nie wydaliśmy jeszcze żadnych wrapperów API, ale planujemy to zrobić w najbliższej przyszłości. Wysłać e-maila do api@forwardemail.net jeśli chcesz być powiadamiany o wydaniu wrappera 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ęzykBiblioteka
RubinFaradaya
Pytonupraszanie
JawaOkHttp
PHPchlać
JavaScriptsuperagent
Node.jssuperagent
Udać sięnetto / http
.NETResztaSharp

Podstawowy identyfikator URI

Bieżąca ścieżka podstawowego identyfikatora URI HTTP to: https://api.forwardemail.net. Starsza ścieżka podstawowego identyfikatora URI HTTP firmy https://forwardemail.net:4000 jest przestarzałe od 1 stycznia 2021 r.

Poświadczenie

Wszystkie punkty końcowe wymagają Twojego Klucz API być ustawionym jako wartość „nazwa użytkownika” żądania Podstawowa autoryzacja nagłówek. Nie martw się – poniżej znajdziesz 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.

KodImię
200OK
400Zła prośba
401Nieautoryzowany
403Zabroniony
404Nie znaleziono
429Zbyt dużo próśb
500Wewnętrzny błąd serwera
501Nie zaimplementowano
502zła Brama
503serwis niedostępny
504Limit czasu bramki
Wskazówka: Jeśli otrzymasz kod statusu 5xx (co nie powinno mieć miejsca), skontaktuj się z nami pod adresem api@forwardemail.net a my pomożemy Ci natychmiast rozwiązać Twój problem.

Lokalizacja

Nasza usługa jest tłumaczona na ponad 25 różnych języków. Wszystkie komunikaty odpowiedzi API są tłumaczone na ostatnie wykryte ustawienia regionalne użytkownika zgłaszającego żądanie API. Możesz to zmienić, przekazując niestandardowy Accept-Language nagłówek. Wypróbuj go, korzystając z menu rozwijanego języka na dole tej strony.

Paginacja

Jeśli chcesz otrzymać powiadomienie o dostępności stronicowania, napisz e-mail api@forwardemail.net.

Konto

Utwórz konto

POST /v1/account

Parametr ciaławymaganyRodzajOpis
emailtakCiąg (e-mail)Adres e-mail
passwordtakStrunowyHasło

Przykładowe zapytanie:

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

Odzyskać konto

GET /v1/account

Przykładowe zapytanie:

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

Zaktualizuj konto

PUT /v1/account

Parametr ciaławymaganyRodzajOpis
emailNieCiąg (e-mail)Adres e-mail
given_nameNieStrunowyImię
family_nameNieStrunowyNazwisko
avatar_urlNieCią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"

Domeny

Wskazówka: Punkty końcowe domeny z nazwą domeny /v1/domains/:domain_name ponieważ ich ścieżka jest wymienna z identyfikatorem domeny :domain_id. Oznacza to, że możesz odwoływać się do domeny przez jej name lub id wartość.

Lista domen

GET /v1/domains

Parametr QuerystringwymaganyRodzajOpis
nameNieCiąg (obsługiwany RegExp)Wyszukaj domeny według nazwy
aliasNieCiąg (obsługiwany RegExp)Wyszukaj domeny według nazwy aliasu
recipientNieCiąg (obsługiwany RegExp)Wyszukaj domeny według odbiorcy

Przykładowe zapytanie:

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

Utwórz domenę

POST /v1/domains

Parametr ciaławymaganyRodzajOpis
domaintakCiąg (FQDN lub IP)W pełni kwalifikowana nazwa domeny („FQDN”) lub adres IP
planNieCiąg (wyliczalny)Typ planu (musi być "free", "enhanced_protection", lub "team", domyślnie "free" lub aktualny płatny abonament użytkownika, jeśli na jednym)
catchallNieCiąg (rozdzielane adresy e-mail) lub wartość logicznaUtwórz domyślny alias typu catch-all, domyślnie true (jeśli true użyje adresu e-mail użytkownika API jako odbiorcy, a jeśli false nie zostanie utworzony żaden catch-all). Jeśli zostanie przekazany ciąg, to jest to rozdzielona lista adresów e-mail, które mają być używane jako odbiorcy (oddzielone podziałem wiersza, spacją i/lub przecinkiem)
has_adult_content_protectionNieBoole'aCzy włączyć w tej domenie ochronę treści dla dorosłych w Skanerze spamu
has_phishing_protectionNieBoole'aCzy włączyć ochronę przed phishingiem Skanera spamu w tej domenie
has_executable_protectionNieBoole'aCzy włączyć ochronę plików wykonywalnych Skanera spamu w tej domenie
has_virus_protectionNieBoole'aCzy włączyć ochronę antywirusową Skanera spamu w tej domenie
has_recipient_verificationNieBoole'aDomyślna domena globalna określająca, czy wymagać od odbiorców aliasów kliknięcia linku weryfikacyjnego adresu e-mail w celu przepłynięcia wiadomości e-mail

Przykładowe zapytanie:

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

Odzyskaj domenę

GET /v1/domains/example.com

Przykładowe zapytanie:

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

Zaktualizuj domenę

PUT /v1/domains/example.com

Parametr ciaławymaganyRodzajOpis
smtp_portNieCiąg lub liczbaNiestandardowy port do skonfigurowania dla przekazywania SMTP (domyślnie "25")
has_adult_content_protectionNieBoole'aCzy włączyć w tej domenie ochronę treści dla dorosłych w Skanerze spamu
has_phishing_protectionNieBoole'aCzy włączyć ochronę przed phishingiem Skanera spamu w tej domenie
has_executable_protectionNieBoole'aCzy włączyć ochronę plików wykonywalnych Skanera spamu w tej domenie
has_virus_protectionNieBoole'aCzy włączyć ochronę antywirusową Skanera spamu w tej domenie
has_recipient_verificationNieBoole'aDomyślna domena globalna określająca, czy wymagać od odbiorców aliasów kliknięcia linku weryfikacyjnego adresu e-mail w celu przepłynięcia wiadomości e-mail

Przykładowe zapytanie:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u 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ławymaganyRodzajOpis
emailtakCiąg (e-mail)Adres e-mail do zaproszenia na listę członków domeny
grouptakCiąg (wyliczalny)Grupa do dodania użytkownika do członkostwa w domenie (może być jedną 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

Usuń zaproszenie do domeny

DELETE /v1/domains/:domain_name/invites

Parametr ciaławymaganyRodzajOpis
emailtakCią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ławymaganyRodzajOpis
grouptakCiąg (wyliczalny)Grupa do aktualizacji użytkownika do członkostwa w domenie (może być jedną 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

Wyświetlanie listy aliasów domen

GET /v1/domains/example.com/aliases

Parametr QuerystringwymaganyRodzajOpis
nameNieCiąg (obsługiwany RegExp)Wyszukaj aliasy w domenie według nazwy
recipientNieCiąg (obsługiwany RegExp)Wyszukaj aliasy w domenie według odbiorcy

Przykładowe zapytanie:

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

Utwórz nowy alias domeny

POST /v1/domains/example.com/aliases

Parametr ciaławymaganyRodzajOpis
nametakStrunowyPseudonim
recipientstakŁańcuch lub tablicaLista 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)
descriptionNieStrunowyOpis aliasu
labelsNieŁańcuch lub tablicaLista etykiet (musi być ciągiem lub tablicą z podziałem wiersza / spacją / przecinkiem)
has_recipient_verificationNieBoole'aCzy włączyć wymaganie od odbiorców kliknięcia linku weryfikacyjnego wiadomości e-mail w celu przepłynięcia wiadomości e-mail (domyślnie jest to ustawienie domeny, jeśli nie zostało to wyraźnie określone w treści żądania)
is_enabledNieBoole'aOkreś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:

Pobierz alias domeny

Możesz pobrać alias domeny przez jego id lub jego name wartość.

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

Przykładowe zapytanie:

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

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

Przykładowe zapytanie:

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

Zaktualizuj alias domeny

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

Parametr ciaławymaganyRodzajOpis
nameNieStrunowyPseudonim
recipientstakŁańcuch lub tablicaLista 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)
descriptionNieStrunowyOpis aliasu
labelsNieŁańcuch lub tablicaLista etykiet (musi być ciągiem lub tablicą z podziałem wiersza / spacją / przecinkiem)
has_recipient_verificationNieBoole'aCzy włączyć wymaganie od odbiorców kliknięcia linku weryfikacyjnego wiadomości e-mail w celu przepłynięcia wiadomości e-mail (domyślnie jest to ustawienie domeny, jeśli nie zostało to wyraźnie określone w treści żądania)
is_enabledNieBoole'aOkreś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: