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.

Přečtěte si naše zásady ochrany osobních údajů a podmínky

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

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

Momentálně jsme zatím žádné API obaly nevydali, ale v blízké budoucnosti to plánujeme. Pošlete e-mail na adresuapi@forwardemail.net pokud chcete být upozorněni, když se uvolní obálka API konkrétního programovacího jazyka. Mezitím můžete ve své aplikaci použít tyto doporučené knihovny požadavků HTTP nebo jednoduše použítkučera jako v níže uvedených příkladech.

Jazyk Knihovna
Rubín Faraday
Krajta žádosti
Jáva OkHttp
PHP žrát
JavaScript superagent
Node.js superagent
Jít net / http
.SÍŤ RestSharp

Základní URI

Aktuální cesta URI základní HTTP je:https://api.forwardemail.net. Původní základní cesta URI protokolu HTTPhttps://forwardemail.net:4000 bude ukončena 1. ledna 2021.

Ověřování

Všechny koncové body vyžadují vašeklíč zdarma API 🎉 nastavit jako „uživatelské jméno“ hodnoty žádostiZákladní autorizace záhlaví. Nebojte se - příklady jsou uvedeny níže, pokud si nejste jisti, co to je.

Chyby

Pokud se vyskytnou nějaké chyby, bude tělo odpovědi požadavku API obsahovat podrobnou chybovou zprávu. Kromě více než deseti let zkušeností s tvorbou API a jejich dokumentováním byly inspiroványStripe je krásná dokumentace API, když jsme vytvořili naši 😄.

Kód název
200 OK
400 Špatný požadavek
401 Neoprávněný
403 Zakázáno
404 Nenalezeno
429 Příliš mnoho žádostí
500 Interní chyba serveru
501 Není implementováno
502 Špatná brána
503 služba je nedostupná
504 Časový limit brány
Tip: If you receive a 5xx status code (which should not happen), then please contact us at api@forwardemail.net and we will help you to resolve your issue immediately.

Lokalizace

Naše služba je přeložena do více než 25 různých jazyků. Všechny zprávy s odpověďmi API jsou přeloženy do posledního detekovaného národního prostředí uživatele, který podal požadavek na rozhraní API. Můžete to přepsat předáním vlastníhoAccept-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, když bude k dispozici stránkování, pošlete e-mailapi@forwardemail.net.

Účet

Vytvořit účet

POST /v1/account

Parametr těla Požadované Typ Popis
email Ano Řetězec (e-mail) Emailová adresa
password Ano Tětiva Heslo

Příklad požadavku:

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

Načíst účet

GET /v1/account

Příklad požadavku:

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

Example Response:

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

Aktualizujte účet

PUT /v1/account

Parametr těla Požadované Typ Popis
email Ne Řetězec (e-mail) Emailová adresa
given_name Ne Tětiva Jméno
family_name Ne Tětiva Příjmení
avatar_url Ne Ř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"

Example Response:

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

Domény

Tip: Domain endpoints with a domain's name /v1/domains/:domain_name as their path are interchangable with a domain's ID :domain_id. This means you can refer to the domain by either its name or id value.

Seznam domén

GET /v1/domains

Parametr dotazu Požadované Typ Popis
name Ne Řetězec (podporováno RegExp) Hledejte domény podle jména
alias Ne Řetězec (podporováno RegExp) Hledejte domény podle aliasu
recipient Ne Ř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:

Example Response:

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

Vytvořit doménu

POST /v1/domains

Parametr těla Požadované Typ Popis
domain Ano Řetězec (FQDN nebo IP) Plně kvalifikovaný název domény („FQDN“) nebo adresa IP
plan Ne Řetězec (počet) Typ plánu (musí být"free","enhanced_protection", nebo"team", výchozí nastavení"free")

Příklad požadavku:

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

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:

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid 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:

Example Response:

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

Aktualizujte doménu

PUT /v1/domains/example.com

Parametr těla Požadované Typ Popis
smtp_port Ne Řetězec nebo číslo Vlastní port pro konfiguraci pro předávání SMTP (výchozí je"25")

Příklad požadavku:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid 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ěla Požadované Typ Popis
email Ano Řetězec (e-mail) E-mailová adresa pro pozvání do seznamu členů domény
group Ano Řetězec (počet) Skupina pro přidání uživatele do členství v doméně s (může být jedním 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

Example Response:

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

Odebrat pozvánku na doménu

DELETE /v1/domains/:domain_name/invites

Parametr těla Požadované Typ Popis
email Ano Ř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ěla Požadované Typ Popis
group Ano Řetězec (počet) Skupina pro aktualizaci uživatele na členství v doméně s (může být jedním 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

Načíst aliasy domén

GET /v1/domains/example.com/aliases

Příklad požadavku:

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

Vytvořit nový alias domény

POST /v1/domains/example.com/aliases

Parametr těla Požadované Typ Popis
name Ano Tětiva Jméno aliasu
recipients Ano Řetězec nebo pole Seznam 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)
description Ne Tětiva Popis aliasu
labels Ne Řetězec nebo pole Seznam štítků (musí být řetězec oddělený mezerou / mezerou nebo čárkou)
is_enabled Ne Boolean 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:

Example Response:

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

Aktualizujte alias domény

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

Parametr těla Požadované Typ Popis
name Ne Tětiva Jméno aliasu
recipients Ano Řetězec nebo pole Seznam 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)
description Ne Tětiva Popis aliasu
labels Ne Řetězec nebo pole Seznam štítků (musí být řetězec oddělený mezerou / mezerou nebo čárkou)
is_enabled Ne Boolean 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: