Tarvitsetko asiakirjoja, joissa on todelliset tiedot ja avaimet?

Sinun tarvitsee vain rekisteröityä tai kirjautua sisään, jotta API-avaimet ja oikeat tilitiedot täytetään alla.

Hyväksyt tietosuojakäytäntömme ja käyttöehtomme .

Etkö ole kiinnostunut? Napsauta tätä jatkaaksesi lukemista

Sisällysluettelo

Olemme luoneet sovellusliittymän verkkotunnusten, aliasten ja muun ohjelmalliseen käyttöön.

API-dokumentaatio

Ohjelmoitu pääsy tietoihisi

Sähköpostin edelleenlähetyksen API

Sisällysluettelo

Kirjastot

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

KieliKirjasto
RubiiniFaraday
Pythonpyynnöt
JavaOkHttp
PHPahmia
JavaScriptsuperagentti
Node.jssuperagentti
Mennänet / http
.NETLepoTerävä

Perus-URI

Nykyinen HTTP-pohjainen URI-polku on: https://api.forwardemail.net. Vanha HTTP-pohjainen URI-polku: https://forwardemail.net:4000 on poistettu käytöstä 1.1.2021 alkaen.

Todennus

Kaikki päätepisteet vaativat sinun API-avain asetetaan pyynnön "käyttäjänimi"-arvoksi Peruslupa otsikko. Älä huoli – alla on esimerkkejä sinulle, jos et ole varma, mikä tämä on.

Virheet

Jos virheitä tapahtuu, API-pyynnön vastausrunko sisältää yksityiskohtaisen virhesanoman.

KoodiNimi
200OK
400Virheellinen pyyntö
401Luvaton
403Kielletty
404Ei löydetty
429Liian monta pyyntöä
500Sisäinen palvelinvirhe
501Ei toteutettu
502Huono yhdyskäytävä
503palvelu ei saatavilla
504Yhdyskäytävän aikakatkaisu
Kärki: Jos saat 5xx-tilakoodin (mitä ei pitäisi tapahtua), ota meihin yhteyttä osoitteessa api@forwardemail.net ja autamme sinua ratkaisemaan ongelmasi välittömästi.

Lokalisointi

Palvelumme on käännetty yli 25 eri kielelle. Kaikki API-vastausviestit käännetään API-pyynnön tehneen käyttäjän viimeksi havaittuun alueeseen. Voit ohittaa tämän ohittamalla mukautetun Accept-Language otsikko. Voit vapaasti kokeilla sitä käyttämällä tämän sivun alareunassa olevaa avattavaa kielivalikkoa.

Sivunumerointi

Jos haluat saada ilmoituksen, kun sivutus on saatavilla, lähetä sähköpostia api@forwardemail.net.

Tili

Luo tili

POST /v1/account

Kehon parametriEdellytetäänTyyppiKuvaus
emailJooMerkkijono (sähköposti)Sähköpostiosoite
passwordJooMerkkijonoSalasana

Esimerkkipyyntö:

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

Nouda tili

GET /v1/account

Esimerkkipyyntö:

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

Päivitä tili

PUT /v1/account

Kehon parametriEdellytetäänTyyppiKuvaus
emailEiMerkkijono (sähköposti)Sähköpostiosoite
given_nameEiMerkkijonoEtunimi
family_nameEiMerkkijonoSukunimi
avatar_urlEiMerkkijono (URL)Linkki avatar-kuvaan

Esimerkkipyyntö:

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

Verkkotunnukset

Kärki: Verkkotunnuksen päätepisteet verkkotunnuksen nimellä /v1/domains/:domain_name koska niiden polku on vaihdettavissa verkkotunnuksen tunnuksen kanssa :domain_id. Tämä tarkoittaa, että voit viitata verkkotunnukseen joko sen perusteella name tai id arvo.

Luettelo verkkotunnuksista

GET /v1/domains

KyselymerkkiparametriEdellytetäänTyyppiKuvaus
nameEiMerkkijono (RegExp tuettu)Hae verkkotunnuksia nimen mukaan
aliasEiMerkkijono (RegExp tuettu)Hae verkkotunnuksia aliaksen nimen perusteella
recipientEiMerkkijono (RegExp tuettu)Hae verkkotunnuksia vastaanottajan mukaan

Esimerkkipyyntö:

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

Luo verkkotunnus

POST /v1/domains

Kehon parametriEdellytetäänTyyppiKuvaus
domainJooMerkkijono (FQDN tai IP)Täysin hyväksytty verkkotunnus ("FQDN") tai IP-osoite
planEiMerkkijono (lueteltava)Suunnitelman tyyppi (täytyy olla "free", "enhanced_protection", tai "team", oletuksena "free" tai käyttäjän nykyinen maksettu sopimus, jos sellainen)
catchallEiMerkkijono (erotetut sähköpostiosoitteet) tai BooleanLuo oletusarvoinen keräilyalias, oletuksena true (jos true se käyttää API-käyttäjän sähköpostiosoitetta vastaanottajana, ja jos false saalis-kaikkia ei luoda). Jos merkkijono välitetään, se on rajattu luettelo sähköpostiosoitteista, joita käytetään vastaanottajina (erottuna rivinvaihdolla, välilyönnillä ja/tai pilkulla).
has_adult_content_protectionEiBoolenOtetaanko Spam Scannerin aikuisille suunnatun sisällön suojaus käyttöön tässä verkkotunnuksessa
has_phishing_protectionEiBoolenOtetaanko roskapostiskannerin tietojenkalastelusuoja käyttöön tässä verkkotunnuksessa
has_executable_protectionEiBoolenOtetaanko Roskapostin skannerin suoritettavien tiedostojen suojaus käyttöön tässä verkkotunnuksessa
has_virus_protectionEiBoolenOtetaanko Spam Scanner -virustorjunta käyttöön tässä verkkotunnuksessa
has_recipient_verificationEiBoolenMaailmanlaajuisen verkkotunnuksen oletusarvo sille, vaaditaanko aliasten vastaanottajia napsauttamaan sähköpostin vahvistuslinkkiä, jotta sähköpostit kulkevat läpi

Esimerkkipyyntö:

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

Hae verkkotunnus

GET /v1/domains/example.com

Esimerkkipyyntö:

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

Vahvista verkkotunnustietueet

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

Esimerkkipyyntö:

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

Päivitä verkkotunnus

PUT /v1/domains/example.com

Kehon parametriEdellytetäänTyyppiKuvaus
smtp_portEiMerkkijono tai numeroMukautettu portti SMTP-edelleenlähetystä varten (oletus on "25")
has_adult_content_protectionEiBoolenOtetaanko Spam Scannerin aikuisille suunnatun sisällön suojaus käyttöön tässä verkkotunnuksessa
has_phishing_protectionEiBoolenOtetaanko roskapostiskannerin tietojenkalastelusuoja käyttöön tässä verkkotunnuksessa
has_executable_protectionEiBoolenOtetaanko Roskapostin skannerin suoritettavien tiedostojen suojaus käyttöön tässä verkkotunnuksessa
has_virus_protectionEiBoolenOtetaanko Spam Scanner -virustorjunta käyttöön tässä verkkotunnuksessa
has_recipient_verificationEiBoolenMaailmanlaajuisen verkkotunnuksen oletusarvo sille, vaaditaanko aliasten vastaanottajia napsauttamaan sähköpostin vahvistuslinkkiä, jotta sähköpostit kulkevat läpi

Esimerkkipyyntö:

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

Poista verkkotunnus

DELETE /v1/domains/:domain_name

Esimerkkipyyntö:

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

Kutsuu

Hyväksy verkkotunnuksen kutsu

GET /v1/domains/:domain_name/invites

Esimerkkipyyntö:

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 parametriEdellytetäänTyyppiKuvaus
emailJooMerkkijono (sähköposti)Sähköpostiosoite, jota kutsutaan verkkotunnuksen jäsenluetteloon
groupJooMerkkijono (lueteltava)Ryhmä, johon käyttäjä lisätään verkkotunnuksen jäsenyyteen (voi olla yksi "admin" tai "user")

Esimerkkipyyntö:

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

Poista verkkotunnuksen kutsu

DELETE /v1/domains/:domain_name/invites

Kehon parametriEdellytetäänTyyppiKuvaus
emailJooMerkkijono (sähköposti)Sähköpostiosoite, joka poistetaan verkkotunnuksen jäsenluettelosta

Esimerkkipyyntö:

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 parametriEdellytetäänTyyppiKuvaus
groupJooMerkkijono (lueteltava)Ryhmä päivittääksesi käyttäjän verkkotunnuksen jäsenyyteen (voi olla yksi "admin" tai "user")

Esimerkkipyyntö:

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

Esimerkkipyyntö:

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

Aliakset

Luettele verkkotunnuksen aliakset

GET /v1/domains/example.com/aliases

KyselymerkkiparametriEdellytetäänTyyppiKuvaus
nameEiMerkkijono (RegExp tuettu)Etsi aliaksia verkkotunnuksesta nimen perusteella
recipientEiMerkkijono (RegExp tuettu)Etsi aliaksia verkkotunnuksesta vastaanottajan mukaan

Esimerkkipyyntö:

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

Luo uusi verkkotunnuksen alias

POST /v1/domains/example.com/aliases

Kehon parametriEdellytetäänTyyppiKuvaus
nameJooMerkkijonoAlias nimi
recipientsJooMerkkijono tai ArrayLuettelo vastaanottajista (täytyy olla rivinvaihto / välilyönti / pilkuilla erotettu merkkijono tai taulukko kelvollisista sähköpostiosoitteista, täysin hyväksytyistä verkkotunnuksista ("FQDN"), IP-osoitteista ja / tai webhook-URL-osoitteista)
descriptionEiMerkkijonoAliaksen kuvaus
labelsEiMerkkijono tai ArrayLuettelo tarroista (täytyy olla rivinvaihto / välilyönti / pilkulla erotettu merkkijono tai taulukko)
has_recipient_verificationEiBoolenOtetaanko käyttöön, vaaditaanko vastaanottajia napsauttamaan sähköpostin vahvistuslinkkiä, jotta sähköpostit kulkevat läpi (oletusarvo on verkkotunnuksen asetus, jos sitä ei ole erikseen määritetty pyynnön tekstiosassa)
is_enabledEiBoolenOtetaanko tämän aliaksen poistaminen käytöstä (jos se on poistettu käytöstä, sähköpostit reititetään mihinkään, mutta palauttavat onnistuneet tilakoodit)

Esimerkkipyyntö:

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

Hae verkkotunnuksen alias

Voit hakea verkkotunnuksen aliaksen joko sen perusteella id tai sen name arvo.

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

Esimerkkipyyntö:

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

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

Esimerkkipyyntö:

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

Päivitä verkkotunnuksen alias

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

Kehon parametriEdellytetäänTyyppiKuvaus
nameEiMerkkijonoAlias nimi
recipientsJooMerkkijono tai ArrayLuettelo vastaanottajista (täytyy olla rivinvaihto / välilyönti / pilkuilla erotettu merkkijono tai taulukko kelvollisista sähköpostiosoitteista, täysin hyväksytyistä verkkotunnuksista ("FQDN"), IP-osoitteista ja / tai webhook-URL-osoitteista)
descriptionEiMerkkijonoAliaksen kuvaus
labelsEiMerkkijono tai ArrayLuettelo tarroista (täytyy olla rivinvaihto / välilyönti / pilkulla erotettu merkkijono tai taulukko)
has_recipient_verificationEiBoolenOtetaanko käyttöön, vaaditaanko vastaanottajia napsauttamaan sähköpostin vahvistuslinkkiä, jotta sähköpostit kulkevat läpi (oletusarvo on verkkotunnuksen asetus, jos sitä ei ole erikseen määritetty pyynnön tekstiosassa)
is_enabledEiBoolenOtetaanko tämän aliaksen poistaminen käytöstä (jos se on poistettu käytöstä, sähköpostit reititetään mihinkään, mutta palauttavat onnistuneet tilakoodit)

Esimerkkipyyntö:

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

Esimerkkipyyntö:

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