Potřebujete dokumenty se skutečnými daty a klíči?

Jednoduše se zaregistrujte nebo se přihlaste, abyste si níže vyplnili své API klíče a skutečná data účtu.

Souhlasíte s našimi zásadami ochrany osobních údajů a podmínkami .

Nemám zájem? Klikněte sem a pokračujte ve čtení

Obsah

Vytvořili jsme API pro programový přístup k doménám, aliasu a dalším.

Dokumentace API

Programový přístup k vašim datům

Email Forwarding API

Obsah

Knihovny

V současné době jsme ještě nevydali žádné obaly API, ale plánujeme tak učinit v blízké budoucnosti. Pošlete e-mail na adresu api@forwardemail.net pokud si přejete být upozorněni na vydání obalu API konkrétního programovacího jazyka. Mezitím můžete ve své aplikaci používat tyto doporučené knihovny požadavků HTTP nebo je jednoduše používat kučera jako v níže uvedených příkladech.

JazykKnihovna
RubínFaraday
Krajtažádosti
JávaOkHttp
PHPžrát
JavaScriptsuperagent
Node.jssuperagent
Jítnet / http
.NETRestSharp

Základní URI

Aktuální cesta základního URI HTTP je: https://api.forwardemail.net. Starší cesta základního URI HTTP pro https://forwardemail.net:4000 je k 1. lednu 2021 zastaralá.

Ověřování

Všechny koncové body vyžadují váš API klíč nastavit jako hodnotu "username" požadavku Základní autorizace záhlaví. Nebojte se – níže jsou uvedeny příklady, pokud si nejste jisti, co to je.

Chyby

Pokud dojde k chybě, tělo odpovědi požadavku API bude obsahovat podrobnou chybovou zprávu.

Kódnázev
200OK
400Špatný požadavek
401Neoprávněný
403Zakázáno
404Nenalezeno
429Příliš mnoho žádostí
500Interní chyba serveru
501Není implementováno
502Špatná brána
503služba je nedostupná
504Časový limit brány
Spropitné: Pokud obdržíte stavový kód 5xx (což by se nemělo stávat), kontaktujte nás prosím na adrese api@forwardemail.net a my vám pomůžeme váš problém okamžitě vyřešit.

Lokalizace

Naše služba je přeložena do více než 25 různých jazyků. Všechny zprávy odpovědí API jsou přeloženy do posledního zjištěného národního prostředí uživatele, který zadává požadavek API. Můžete to přepsat předáním zvyku Accept-Language záhlaví. Neváhejte a vyzkoušejte to pomocí rozbalovací nabídky jazyků v dolní části této stránky.

Stránkování

Pokud chcete být upozorněni, až bude stránkování dostupné, pošlete nám e-mail api@forwardemail.net.

Účet

Vytvořit účet

POST /v1/account

Parametr tělaPožadovanéTypPopis
emailAnoŘetězec (e-mail)Emailová adresa
passwordAnoTětivaHeslo

Příklad požadavku:

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

Načíst účet

GET /v1/account

Příklad požadavku:

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

Aktualizujte účet

PUT /v1/account

Parametr tělaPožadovanéTypPopis
emailNeŘetězec (e-mail)Emailová adresa
given_nameNeTětivaJméno
family_nameNeTětivaPříjmení
avatar_urlNeŘetězec (URL)Odkaz na obrázek avatar

Příklad požadavku:

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

Domény

Spropitné: Koncové body domény s názvem domény /v1/domains/:domain_name protože jejich cesta je zaměnitelná s ID domény :domain_id. To znamená, že můžete odkazovat na doménu buď její name nebo id hodnota.

Seznam domén

GET /v1/domains

Parametr dotazuPožadovanéTypPopis
nameNeŘetězec (podporováno RegExp)Hledejte domény podle jména
aliasNeŘetězec (podporováno RegExp)Hledejte domény podle aliasu
recipientNeŘetězec (podporováno RegExp)Vyhledejte domény podle příjemce

Příklad požadavku:

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

Vytvořit doménu

POST /v1/domains

Parametr tělaPožadovanéTypPopis
domainAnoŘetězec (FQDN nebo IP)Plně kvalifikovaný název domény („FQDN“) nebo adresa IP
planNeŘetězec (počet)Typ plánu (musí být "free", "enhanced_protection"nebo "team", výchozí je "free" nebo aktuální placený plán uživatele, pokud jej má)
catchallNeŘetězec (oddělené e-mailové adresy) nebo logická hodnotaVytvořte výchozí univerzální alias, výchozí hodnota je true (li true jako příjemce použije e-mailovou adresu uživatele API a pokud false nebude vytvořen žádný catch-all). Pokud je předán řetězec, jedná se o oddělený seznam e-mailových adres, které lze použít jako příjemce (oddělené zalomením řádku, mezerou a/nebo čárkou)
has_adult_content_protectionNeBooleovskýZda povolit v této doméně ochranu obsahu pro dospělé Spam Scanner
has_phishing_protectionNeBooleovskýZda povolit ochranu proti phishingu Spam Scanner v této doméně
has_executable_protectionNeBooleovskýZda povolit spustitelnou ochranu Spam Scanner v této doméně
has_virus_protectionNeBooleovskýZda povolit antivirovou ochranu Spam Scanner v této doméně
has_recipient_verificationNeBooleovskýVýchozí nastavení globální domény pro to, zda mají příjemci aliasů vyžadovat, aby klikali na odkaz pro ověření e-mailu, aby mohly e-maily procházet

Příklad požadavku:

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

Načíst doménu

GET /v1/domains/example.com

Příklad požadavku:

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

Ověřte záznamy domény

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

Příklad požadavku:

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

Aktualizujte doménu

PUT /v1/domains/example.com

Parametr tělaPožadovanéTypPopis
smtp_portNeŘetězec nebo čísloVlastní port pro konfiguraci pro předávání SMTP (výchozí je "25")
has_adult_content_protectionNeBooleovskýZda povolit v této doméně ochranu obsahu pro dospělé Spam Scanner
has_phishing_protectionNeBooleovskýZda povolit ochranu proti phishingu Spam Scanner v této doméně
has_executable_protectionNeBooleovskýZda povolit spustitelnou ochranu Spam Scanner v této doméně
has_virus_protectionNeBooleovskýZda povolit antivirovou ochranu Spam Scanner v této doméně
has_recipient_verificationNeBooleovskýVýchozí nastavení globální domény pro to, zda mají příjemci aliasů vyžadovat, aby klikali na odkaz pro ověření e-mailu, aby mohly e-maily procházet

Příklad požadavku:

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

Smazat doménu

DELETE /v1/domains/:domain_name

Příklad požadavku:

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

Pozvánky

Přijmout pozvání do domény

GET /v1/domains/:domain_name/invites

Příklad požadavku:

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

Vytvořit pozvánku na doménu

POST /v1/domains/example.com/invites

Parametr tělaPožadovanéTypPopis
emailAnoŘetězec (e-mail)E-mailová adresa pro pozvání do seznamu členů domény
groupAnoŘetězec (počet)Skupina pro přidání uživatele do členství v doméně (může to být jedna z "admin" nebo "user")

Příklad požadavku:

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

Odebrat pozvánku na doménu

DELETE /v1/domains/:domain_name/invites

Parametr tělaPožadovanéTypPopis
emailAnoŘetězec (e-mail)E-mailová adresa, kterou chcete odstranit ze seznamu členů domény

Příklad požadavku:

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

Členové

Aktualizujte člena domény

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

Parametr tělaPožadovanéTypPopis
groupAnoŘetězec (počet)Skupina pro aktualizaci uživatele na členství v doméně (může to být jedna z "admin" nebo "user")

Příklad požadavku:

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

Odebrat člena domény

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

Příklad požadavku:

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

Aliasy

Vypsat aliasy domén

GET /v1/domains/example.com/aliases

Parametr dotazuPožadovanéTypPopis
nameNeŘetězec (podporováno RegExp)Vyhledejte aliasy v doméně podle názvu
recipientNeŘetězec (podporováno RegExp)Vyhledejte aliasy v doméně podle příjemce

Příklad požadavku:

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

Vytvořit nový alias domény

POST /v1/domains/example.com/aliases

Parametr tělaPožadovanéTypPopis
nameAnoTětivaJméno aliasu
recipientsAnoŘetězec nebo poleSeznam příjemců (musí být řetězec oddělený mezerou / mezerou / čárkou nebo pole platných e-mailových adres, plně kvalifikovaných doménových jmen („FQDN“), IP adres a / nebo adres URL pro webhook)
descriptionNeTětivaPopis aliasu
labelsNeŘetězec nebo poleSeznam štítků (musí být řetězec oddělený mezerou / mezerou nebo čárkou)
has_recipient_verificationNeBooleovskýZda povolit, aby příjemci klikli na odkaz pro ověření e-mailu, aby e-maily procházely (výchozí nastavení domény, pokud není výslovně nastaveno v těle požadavku)
is_enabledNeBooleovskýZda se má zakázat tento alias (pokud je zakázán, e-maily nebudou směrovány nikde, ale vrátí úspěšné stavové kódy)

Příklad požadavku:

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

Načíst alias domény

Alias domény můžete načíst buď jeho id nebo jeho name hodnota.

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

Příklad požadavku:

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

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

Příklad požadavku:

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

Aktualizujte alias domény

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

Parametr tělaPožadovanéTypPopis
nameNeTětivaJméno aliasu
recipientsAnoŘetězec nebo poleSeznam příjemců (musí být řetězec oddělený mezerou / mezerou / čárkou nebo pole platných e-mailových adres, plně kvalifikovaných doménových jmen („FQDN“), IP adres a / nebo adres URL pro webhook)
descriptionNeTětivaPopis aliasu
labelsNeŘetězec nebo poleSeznam štítků (musí být řetězec oddělený mezerou / mezerou nebo čárkou)
has_recipient_verificationNeBooleovskýZda povolit, aby příjemci klikli na odkaz pro ověření e-mailu, aby e-maily procházely (výchozí nastavení domény, pokud není výslovně nastaveno v těle požadavku)
is_enabledNeBooleovskýZda se má zakázat tento alias (pokud je zakázán, e-maily nebudou směrovány nikde, ale vrátí úspěšné stavové kódy)

Příklad požadavku:

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

Odstranit alias domény

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

Příklad požadavku:

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