Sähköpostin edelleenlähetysliittymä

Sisällysluettelo

• kirjastot
• Perus-URI
• Authentication
• virheet
• lokalisointi
• Sivunumerointi
• Tili
  • Luo tili
  • Hae tili
  • Päivitä tili
• verkkotunnukset
  • Listaa verkkotunnukset
  • Luo verkkotunnus
  • Hae verkkotunnus
  • Varmista verkkotunnuksen tietueet
  • Päivitä verkkotunnus
  • Poista verkkotunnus
• kutsut
  • Hyväksy verkkotunnuksen kutsu
  • Luo verkkotunnuksen kutsu
  • Poista verkkotunnuksen kutsu
• Jäsenet
  • Päivitä verkkotunnuksen jäsen
  • Poista verkkotunnuksen jäsen
• aliakset
  • Hae verkkotunnuksen aliakset
  • Luo uusi verkkotunnuksen alias
  • Päivitä verkkotunnuksen alias
  • Poista verkkotunnuksen alias

kirjastot

Tällä hetkellä emme ole vielä julkaissut yhtään API-käärettä, mutta aiomme tehdä sen lähitulevaisuudessa. Lähetä sähköpostia osoitteeseenapi@forwardemail.net jos haluat saada ilmoituksen, kun tietyn ohjelmointikielen API-kääre vapautetaan. Sillä välin voit käyttää näitä suositeltuja HTTP-pyyntökirjastoja sovelluksessasi tai yksinkertaisesti käyttääkiemura kuten alla olevissa esimerkeissä.

Kieli	Kirjasto
Rubiini	Faradayn
pytonkäärme	pyynnöt
Jaava	OkHttp
PHP	ahmia
JavaScript	superagent
Node.js	superagent
Mennä	net / http
.NETTO	RestSharp

Perus-URI

Nykyinen HTTP-perus-URI-polku on:https://api.forwardemail.net. Vanha HTTP-perus-URI-polkuhttps://forwardemail.net:4000 poistetaan käytöstä 1. tammikuuta 2021.

Authentication

Kaikki päätepisteet vaativat sinunilmainen API-avain 🎉 asetetaan pyynnön käyttäjänimeksiPerusvaltuutus header. Älä huoli - alla on esimerkkejä sinulle, jos et ole varma, mikä tämä on.

virheet

Jos virheitä ilmenee, API-pyynnön vastauskappale sisältää yksityiskohtaisen virheviestin. Sen lisäksi, että sillä on yli kymmenen vuoden kokemus API: n kirjoittamisesta ja dokumentoinnista, he saivat inspiraatiotaraita: n kaunis API-dokumentaatio, kun teimme omaa 😄.

Koodi	Nimi
200	kunnossa
400	Huono pyyntö
401	luvaton
403	Kielletty
404	Ei löydetty
429	Liian monta pyyntöä
500	Sisäinen palvelinvirhe
501	Ei toteutettu
502	Huono portti
503	palvelu ei saatavilla
504	Yhdyskäytävän aikakatkaisu

lokalisointi

Palvelumme on käännetty yli 25 eri kielelle. Kaikki API-vastausviestit käännetään sovellusliittymäpyynnön esittäneen käyttäjän viimeksi havaittuun sijaintiin. Voit ohittaa tämän ohittamalla mukautuksenAccept-Language header. Kokeile sitä vapaasti käyttämällä tämän sivun alaosassa olevaa avattavaa kieltä.

Sivunumerointi

Jos haluat ilmoituksen, kun sivutusta on saatavilla, lähetä sähköpostiaapi@forwardemail.net.

Tili

Luo tili

POST /v1/account

Kehon parametri	Vaaditaan	Tyyppi	Kuvaus
email	Joo	Merkkijono (sähköposti)	Sähköpostiosoite
password	Joo	jono	Salasana

Esimerkki pyynnöstä:

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

Hae tili

GET /v1/account

Esimerkki pyynnöstä:

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

Example Response:

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

Päivitä tili

PUT /v1/account

Kehon parametri	Vaaditaan	Tyyppi	Kuvaus
email	Ei	Merkkijono (sähköposti)	Sähköpostiosoite
given_name	Ei	jono	Etunimi
family_name	Ei	jono	Sukunimi
avatar_url	Ei	Merkkijono (URL)	Linkki avatar-kuvaan

Esimerkki pyynnöstä:

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

verkkotunnukset

Listaa verkkotunnukset

GET /v1/domains

Kiertovirtaparametri	Vaaditaan	Tyyppi	Kuvaus
name	Ei	Merkkijono (RegExp-tuettu)	Etsi verkkotunnuksia nimen mukaan
alias	Ei	Merkkijono (RegExp-tuettu)	Etsi verkkotunnuksia aliasnimen perusteella
recipient	Ei	Merkkijono (RegExp-tuettu)	Etsi verkkotunnuksia vastaanottajan mukaan

Esimerkki pyynnöstä:

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

Example Response:

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

Luo verkkotunnus

POST /v1/domains

Kehon parametri	Vaaditaan	Tyyppi	Kuvaus
domain	Joo	Merkkijono (FQDN tai IP)	Täysin kelvollinen verkkotunnus ("FQDN") tai IP-osoite
plan	Ei	Merkkijono (lueteltava)	Suunnitelmatyyppi (täytyy olla"free","enhanced_protection"tai"team", oletusarvo on"free")

Esimerkki pyynnöstä:

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

Hae verkkotunnus

GET /v1/domains/example.com

Esimerkki pyynnöstä:

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

Example Response:

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

Varmista verkkotunnuksen tietueet

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

Esimerkki pyynnöstä:

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

Päivitä verkkotunnus

PUT /v1/domains/example.com

Kehon parametri	Vaaditaan	Tyyppi	Kuvaus
smtp_port	Ei	Merkkijono tai numero	Mukautettu portti SMTP - edelleenlähetysten määrittämiseen (oletus on"25")

Esimerkki pyynnöstä:

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

Example Response:

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

Poista verkkotunnus

DELETE /v1/domains/:domain_name

Esimerkki pyynnöstä:

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

kutsut

Hyväksy verkkotunnuksen kutsu

GET /v1/domains/:domain_name/invites

Esimerkki pyynnöstä:

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

Luo verkkotunnuksen kutsu

POST /v1/domains/example.com/invites

Kehon parametri	Vaaditaan	Tyyppi	Kuvaus
email	Joo	Merkkijono (sähköposti)	Sähköpostiosoite, joka kutsutaan verkkotunnuksen jäsenluetteloon
group	Joo	Merkkijono (lueteltava)	Ryhmä, jolla käyttäjä lisätään verkkotunnuksen jäseneksi (voi olla yksi verkkotunnuksesta)"admin" tai"user")

Esimerkki pyynnöstä:

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

Poista verkkotunnuksen kutsu

DELETE /v1/domains/:domain_name/invites

Kehon parametri	Vaaditaan	Tyyppi	Kuvaus
email	Joo	Merkkijono (sähköposti)	Poista sähköpostiosoite verkkotunnuksen jäsenluettelosta

Esimerkki pyynnöstä:

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

Jäsenet

Päivitä verkkotunnuksen jäsen

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

Kehon parametri	Vaaditaan	Tyyppi	Kuvaus
group	Joo	Merkkijono (lueteltava)	Ryhmä, jolla päivitetään käyttäjä verkkotunnuksen jäseneksi (voi olla yksi verkkotunnuksesta)"admin" tai"user")

Esimerkki pyynnöstä:

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

Poista verkkotunnuksen jäsen

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

Esimerkki pyynnöstä:

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

aliakset

Hae verkkotunnuksen aliakset

GET /v1/domains/example.com/aliases

Esimerkki pyynnöstä:

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

Luo uusi verkkotunnuksen alias

POST /v1/domains/example.com/aliases

Kehon parametri	Vaaditaan	Tyyppi	Kuvaus
name	Joo	jono	Alias nimi
recipients	Joo	Merkkijono tai ryhmä	Vastaanottajien luettelo (täytyy olla rivinvaihto / välilyönti / pilkuilla erotettu merkkijono tai taulukko kelvollisia sähköpostiosoitteita, täysin kelvolliset verkkotunnukset ("FQDN"), IP-osoitteet ja / tai webhook URL-osoitteet)
description	Ei	jono	Alias kuvaus
labels	Ei	Merkkijono tai ryhmä	Tunnisteluettelo (täytyy olla rivinvaihto / välilyönti / pilkkuerotettu merkkijono tai taulukko)
is_enabled	Ei	boolean	Aktivoidaanko tämän aliaksen poistaminen käytöstä (jos se on poistettu käytöstä, sähköposteja ei reititetä minnekään, mutta palautetaan onnistuneet tilakoodit)

Esimerkki pyynnöstä:

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

Päivitä verkkotunnuksen alias

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

Kehon parametri	Vaaditaan	Tyyppi	Kuvaus
name	Ei	jono	Alias nimi
recipients	Joo	Merkkijono tai ryhmä	Vastaanottajien luettelo (täytyy olla rivinvaihto / välilyönti / pilkuilla erotettu merkkijono tai taulukko kelvollisia sähköpostiosoitteita, täysin kelvolliset verkkotunnukset ("FQDN"), IP-osoitteet ja / tai webhook URL-osoitteet)
description	Ei	jono	Alias kuvaus
labels	Ei	Merkkijono tai ryhmä	Tunnisteluettelo (täytyy olla rivinvaihto / välilyönti / pilkkuerotettu merkkijono tai taulukko)
is_enabled	Ei	boolean	Aktivoidaanko tämän aliaksen poistaminen käytöstä (jos se on poistettu käytöstä, sähköposteja ei reititetä minnekään, mutta palautetaan onnistuneet tilakoodit)

Esimerkki pyynnöstä:

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

Poista verkkotunnuksen alias

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

Esimerkki pyynnöstä:

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