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.

Olvassa el az adatvédelmi irányelveinket és feltételeinket

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

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 tettünk közzé egyetlen API-csomagolást sem, de azt tervezzük, hogy a közeljövőben megtesszük. Küldjön e-mailt aapi@forwardemail.net ha szeretne értesítést kapni egy adott programozási nyelv API-csomagolójának kiadásáról. Időközben használhatja ezeket az ajánlott HTTP kérési könyvtárakat az alkalmazásában, vagy egyszerűen csak használhatjabecsavar mint az alábbi példákban.

Nyelv Könyvtár
Rubin Faraday
Piton kérelmek
Jáva OkHttp
PHP zabál
JavaScript superagent
node.js superagent
Megy net / http
.HÁLÓ RestSharp

Alap URI

A jelenlegi HTTP alap URI elérési út:https://api.forwardemail.net. A régebbi HTTP alap URI elérési útjahttps://forwardemail.net:4000 2021. január 1-jén megszűnik.

Hitelesítés

Minden végpont megköveteli aingyenes API kulcs 🎉 a kérelem "felhasználónév" értékeként kell beállítaniAlapvető engedély fejléc. Ne aggódjon - az alábbiakban példákat találunk, ha nem biztos benne, mi ez.

hibák

Ha bármilyen hiba jelentkezik, az API-kérés választestje tartalmaz egy részletes hibaüzenetet. Amellett, hogy több mint tíz éves tapasztalattal rendelkezik az API-k megírásában és dokumentálásában, az ihletteCsíkok gyönyörű API dokumentáció, amikor elkészítettük a miénket 😄.

Kód Név
200 rendben
400 Rossz kérés
401 jogtalan
403 Tiltott
404 Nem található
429 Túl sok kérés
500 Belső Szerverhiba
501 Nincs implementálva
502 Rossz átjáró
503 A szolgáltatás nem elérhető
504 Átjáró időkorlátja
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.

Honosítás

Szolgáltatásunkat több mint 25 különböző nyelvre fordítják. Az összes API-válaszüzenetet lefordítják az API-kérelmet benyújtó felhasználó utolsó észlelési helyére. Ezt felülbírálhatja egy szokás átadásávalAccept-Language fejléc. Kipróbálhatja az oldal alján található legördülő menü segítségével.

Lapszámozás

Ha szeretne értesítést kapni arról, hogy rendelkezésre áll oldal, akkor kérjük, írjon e-mailtapi@forwardemail.net.

számla

Fiók létrehozása

POST /v1/account

Testparaméter Kívánt típus Leírás
email Igen Karakterlánc (e-mail) Email cím
password Igen Húr Jelszó

Példakérés:

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

Fiók letöltése

GET /v1/account

Példakérés:

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

Example Response:

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

Fiók frissítése

PUT /v1/account

Testparaméter Kívánt típus Leírás
email Nem Karakterlánc (e-mail) Email cím
given_name Nem Húr Keresztnév
family_name Nem Húr Vezetéknév
avatar_url Nem Karakterlá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"

Example Response:

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

Domains

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

Domainek felsorolása

GET /v1/domains

Querystring paraméter Kívánt típus Leírás
name Nem Karakterlánc (RegExp támogatott) Keressen domaineket név szerint
alias Nem Karakterlánc (RegExp támogatott) Keressen domaineket álnév alapján
recipient Nem Karakterlá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:

Example Response:

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

Hozzon létre tartományt

POST /v1/domains

Testparaméter Kívánt típus Leírás
domain Igen Karakterlánc (FQDN vagy IP) Teljesen minősített domain név ("FQDN") vagy IP cím
plan Nem Karakterlánc (számolható) Terv típusa (kell lennie"free","enhanced_protection"vagy"team", alapértelmezés szerint"free")
catchall Nem 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)

Példakérés:

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

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:

Example Response:

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

Example Response:

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

Frissítse a domaint

PUT /v1/domains/example.com

Testparaméter Kívánt típus Leírás
smtp_port Nem Karakterlánc vagy szám Egyéni port az SMTP továbbítás konfigurálásához (alapértelmezés:"25")

Példakérés:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid 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éter Kívánt típus Leírás
email Igen Karakterlánc (e-mail) E-mail cím, amelyet meghívhat a domain tagok listájára
group Igen Karakterlánc (számolható) Csoport, amellyel a felhasználót felveheti a domain tagságba a következővel (lehet az egyik:"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

Example Response:

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

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

DELETE /v1/domains/:domain_name/invites

Testparaméter Kívánt típus Leírás
email Igen Karakterlá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éter Kívánt típus Leírás
group Igen Karakterlánc (számolható) Csoport, amellyel a felhasználót frissítheti a domain tagsággal a következővel (lehet az egyik:"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

Beolvassa a domain álneveket

GET /v1/domains/example.com/aliases

Példakérés:

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

Hozzon létre új domain álnevet

POST /v1/domains/example.com/aliases

Testparaméter Kívánt típus Leírás
name Igen Húr Fedőnév
recipients Igen Karakterlánc vagy array Cí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)
description Nem Húr Álnév leírása
labels Nem Karakterlánc vagy array Címkék listája (soroknak / szóköznek / vesszővel elválasztott karakterláncnak vagy tömbnek kell lennie)
is_enabled Nem logikai Engedé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:

Example Response:

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

Frissítse a domain álnevet

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

Testparaméter Kívánt típus Leírás
name Nem Húr Fedőnév
recipients Igen Karakterlánc vagy array Cí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)
description Nem Húr Álnév leírása
labels Nem Karakterlánc vagy array Címkék listája (soroknak / szóköznek / vesszővel elválasztott karakterláncnak vagy tömbnek kell lennie)
is_enabled Nem logikai Engedé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: