Szüksége van valós adatokkal és kulcsokkal rendelkező dokumentumokra?

Csak regisztráljon vagy jelentkezzen be, hogy az API kulcsokat és a valós számlaadatokat alább feltöltse.

Ön elfogadja adatvédelmi szabályzatunkat és feltételeinket .

Nem érdekel? Kattintson ide az olvasás folytatásához

Tartalomjegyzék

Létrehozott egy API-t a domainek, álnevek és egyebekhez való programozási hozzáféréshez.

API dokumentáció

Programozott hozzáférés az Ön adataihoz

E-mail továbbítás API

Tartalomjegyzék

könyvtárak

Jelenleg még nem adtunk ki API-burkolókat, de a közeljövőben ezt tervezzük. Küldj e-mailt a címre api@forwardemail.net ha szeretne értesítést kapni egy adott programozási nyelv API burkolójának kiadásáról. Addig is használhatja ezeket az ajánlott HTTP-kérés-könyvtárakat az alkalmazásban, vagy egyszerűen csak becsavar mint az alábbi példákban.

NyelvKönyvtár
RubinFaraday
Pitonkérelmek
JávaOkHttp
PHPzabál
JavaScriptszuperügynök
node.jsszuperügynök
Megynet / http
.NETRestSharp

Alap URI

A jelenlegi HTTP-alapú URI-útvonal a következő: https://api.forwardemail.net. Az örökölt HTTP-alapú URI-útvonal https://forwardemail.net:4000 2021. január 1-jével megszűnt.

Hitelesítés

Minden végpont megköveteli az Ön API kulcs a kérés "felhasználónév" értékeként kell beállítani Alapvető engedély fejléc. Ne aggódjon – az alábbiakban példákat mutatunk be, ha nem biztos benne, hogy mi ez.

hibák

Ha bármilyen hiba lép fel, az API kérés választörzse részletes hibaüzenetet tartalmaz.

KódNév
200OK
400Rossz kérés
401jogtalan
403Tiltott
404Nem található
429Túl sok kérés
500Belső Szerverhiba
501Nincs implementálva
502Rossz átjáró
503A szolgáltatás nem elérhető
504Átjáró időkorlátja
Tipp: Ha 5xx állapotkódot kap (aminek nem szabad megtörténnie), kérjük, vegye fel velünk a kapcsolatot a telefonszámon api@forwardemail.net és azonnal segítünk a probléma megoldásában.

Honosítás

Szolgáltatásunk több mint 25 különböző nyelvre van lefordítva. Minden API-válaszüzenet az API-kérelmet benyújtó felhasználó utoljára észlelt területi beállítására fordítja le. Ezt felülírhatja egy egyéni átadásával Accept-Language fejléc. Nyugodtan próbálja ki az oldal alján található nyelvi legördülő menü segítségével.

Lapszámozás

Ha szeretne értesítést kapni, amikor elérhető az oldalszámozás, kérjük, írjon e-mailt api@forwardemail.net.

számla

Fiók létrehozása

POST /v1/account

TestparaméterKívánttípusLeírás
emailIgenKarakterlánc (e-mail)Email cím
passwordIgenHúrJelszó

Példakérés:

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

Fiók letöltése

GET /v1/account

Példakérés:

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

Fiók frissítése

PUT /v1/account

TestparaméterKívánttípusLeírás
emailNemKarakterlánc (e-mail)Email cím
given_nameNemHúrKeresztnév
family_nameNemHúrVezetéknév
avatar_urlNemKarakterlánc (URL)Link avatar képhez

Példakérés:

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

Domainek

Tipp: Tartományi végpontok egy tartománynévvel /v1/domains/:domain_name mivel az útvonaluk felcserélhető egy domain azonosítójával :domain_id. Ez azt jelenti, hogy bármelyikével hivatkozhat a domainre name vagy id érték.

Domainek felsorolása

GET /v1/domains

Querystring paraméterKívánttípusLeírás
nameNemKarakterlánc (RegExp támogatott)Keressen domaineket név szerint
aliasNemKarakterlánc (RegExp támogatott)Keressen domaineket álnév alapján
recipientNemKarakterlánc (RegExp támogatott)Keressen domaineket címzett szerint

Példakérés:

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

Hozzon létre tartományt

POST /v1/domains

TestparaméterKívánttípusLeírás
domainIgenKarakterlánc (FQDN vagy IP)Teljesen minősített domain név ("FQDN") vagy IP cím
planNemKarakterlánc (számolható)Terv típusa ( kell lennie "free", "enhanced_protection", vagy "team", alapértelmezés szerint "free" vagy a felhasználó aktuális fizetett előfizetése, ha van ilyen)
catchallNemKarakterlánc (elválasztott e-mail címek) vagy logikaiHozzon létre egy alapértelmezett gyűjtőálnevet, alapértelmezés szerint true (ha true az API felhasználó e-mail címét fogja használni címzettként, és ha false nem jön létre összesítő). Ha egy karakterláncot adunk át, akkor ez a címzettként használandó e-mail címek elválasztott listája (sortöréssel, szóközzel és/vagy vesszővel elválasztva)
has_adult_content_protectionNemlogikaiEngedélyezze-e a Spam Scanner felnőtt tartalom védelmét ezen a domainen
has_phishing_protectionNemlogikaiEngedélyezze-e a Spam Scanner adathalász-védelmet ezen a tartományon
has_executable_protectionNemlogikaiEngedélyezze-e a Spam Scanner végrehajtható fájlvédelmét ezen a tartományon
has_virus_protectionNemlogikaiEngedélyezze-e a Spam Scanner vírusvédelmet ezen a tartományon
has_recipient_verificationNemlogikaiA globális domain alapértelmezett beállítása, hogy megköveteljék-e az alias címzetteket, hogy rákattintsák az e-mail-ellenőrző hivatkozásra az e-mailek áthaladásához

Példakérés:

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

Beolvasás domain

GET /v1/domains/example.com

Példakérés:

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

Ellenőrizze a domain rekordokat

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

Példakérés:

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

Frissítse a domaint

PUT /v1/domains/example.com

TestparaméterKívánttípusLeírás
smtp_portNemKarakterlánc vagy számEgyéni port az SMTP továbbításhoz (alapértelmezett: "25")
has_adult_content_protectionNemlogikaiEngedélyezze-e a Spam Scanner felnőtt tartalom védelmét ezen a domainen
has_phishing_protectionNemlogikaiEngedélyezze-e a Spam Scanner adathalász-védelmet ezen a tartományon
has_executable_protectionNemlogikaiEngedélyezze-e a Spam Scanner végrehajtható fájlvédelmét ezen a tartományon
has_virus_protectionNemlogikaiEngedélyezze-e a Spam Scanner vírusvédelmet ezen a tartományon
has_recipient_verificationNemlogikaiA globális domain alapértelmezett beállítása, hogy megköveteljék-e az alias címzetteket, hogy rákattintsák az e-mail-ellenőrző hivatkozásra az e-mailek áthaladásához

Példakérés:

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

Domain törlése

DELETE /v1/domains/:domain_name

Példakérés:

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

Meghívottak

Fogadja el a domain meghívást

GET /v1/domains/:domain_name/invites

Példakérés:

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

Hozzon létre domain meghívást

POST /v1/domains/example.com/invites

TestparaméterKívánttípusLeírás
emailIgenKarakterlánc (e-mail)E-mail cím, amelyet meghívhat a domain tagok listájára
groupIgenKarakterlánc (számolható)Csoport, amellyel a felhasználót hozzáadhatja a domain tagsághoz (az egyik lehet "admin" vagy "user")

Példakérés:

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

Távolítsa el a domain meghívást

DELETE /v1/domains/:domain_name/invites

TestparaméterKívánttípusLeírás
emailIgenKarakterlánc (e-mail)E-mail cím, amelyet el kell távolítani a domain tagok listájáról

Példakérés:

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

Belépés

Frissítse a domain tagot

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

TestparaméterKívánttípusLeírás
groupIgenKarakterlánc (számolható)Csoport, amely frissíti a felhasználót a domain tagságra a következővel (az egyik lehet "admin" vagy "user")

Példakérés:

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

Távolítsa el a domain tagot

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

Példakérés:

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

Más nevek

Domain álnevek listázása

GET /v1/domains/example.com/aliases

Querystring paraméterKívánttípusLeírás
nameNemKarakterlánc (RegExp támogatott)Keresse meg a domain álneveit név szerint
recipientNemKarakterlánc (RegExp támogatott)Aliasok keresése egy tartományban címzett szerint

Példakérés:

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

Hozzon létre új domain álnevet

POST /v1/domains/example.com/aliases

TestparaméterKívánttípusLeírás
nameIgenHúrFedőnév
recipientsIgenKarakterlánc vagy arrayCímzettek listája (sor törés / szóköz / vesszővel elválasztott érvényes e-mail címek, teljesen minősített domain nevek ("FQDN"), IP címek és / vagy webhook URL-ek tömbjének vagy tömbének kell lennie)
descriptionNemHúrÁlnév leírása
labelsNemKarakterlánc vagy arrayCímkék listája (soroknak / szóköznek / vesszővel elválasztott karakterláncnak vagy tömbnek kell lennie)
has_recipient_verificationNemlogikaiEngedélyezni kell-e, hogy a címzettek egy e-mail-ellenőrző hivatkozásra kattintsanak az e-mailek áthaladásához (alapértelmezés a domain beállítása, ha nincs kifejezetten beállítva a kérés törzsében)
is_enabledNemlogikaiEngedélyezi-e ennek az álnévnek a letiltását (ha le van tiltva, az e-mailek sehova nem kerülnek, de a sikeres állapotkódokat adja vissza)

Példakérés:

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

Domain alias lekérése

A domain aliast bármelyikével lekérheti id vagy annak name érték.

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

Példakérés:

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

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

Példakérés:

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

Frissítse a domain álnevet

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

TestparaméterKívánttípusLeírás
nameNemHúrFedőnév
recipientsIgenKarakterlánc vagy arrayCímzettek listája (sor törés / szóköz / vesszővel elválasztott érvényes e-mail címek, teljesen minősített domain nevek ("FQDN"), IP címek és / vagy webhook URL-ek tömbjének vagy tömbének kell lennie)
descriptionNemHúrÁlnév leírása
labelsNemKarakterlánc vagy arrayCímkék listája (soroknak / szóköznek / vesszővel elválasztott karakterláncnak vagy tömbnek kell lennie)
has_recipient_verificationNemlogikaiEngedélyezni kell-e, hogy a címzettek egy e-mail-ellenőrző hivatkozásra kattintsanak az e-mailek áthaladásához (alapértelmezés a domain beállítása, ha nincs kifejezetten beállítva a kérés törzsében)
is_enabledNemlogikaiEngedélyezi-e ennek az álnévnek a letiltását (ha le van tiltva, az e-mailek sehova nem kerülnek, de a sikeres állapotkódokat adja vissza)

Példakérés:

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

Törölje a domain álnevet

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

Példakérés:

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