Behöver du dokument med verkliga data och nycklar?

Registrera dig helt enkelt eller logga in för att få dina API-nycklar och faktiska kontodata fyllda nedan.

Du godkänner vår integritetspolicy och våra villkor .

Inte intresserad? Klicka här för att fortsätta läsa

Innehållsförteckning

Vi skapade ett API för programmatisk åtkomst till domäner, alias och mer.

API-dokumentation

Programmatisk åtkomst till dina data

E-post vidarebefordra API

Innehållsförteckning

bibliotek

Just nu har vi ännu inte släppt några API-omslag, men vi planerar att göra det inom en snar framtid. Skicka ett mail till api@forwardemail.net om du vill bli meddelad när ett visst programmeringsspråks API-omslag släpps. Under tiden kan du använda dessa rekommenderade HTTP-förfrågningsbibliotek i din applikation, eller helt enkelt använda ringla som i exemplen nedan.

SpråkBibliotek
RubinFaraday
Pytonormförfrågningar
JavaOkHttp
PHPSUPA
JavaScriptsuperagent
Node.jssuperagent
net / http
.NETRestSharp

Bas URI

Den aktuella HTTP-bas-URI-sökvägen är: https://api.forwardemail.net. Den äldre HTTP-bas-URI-sökvägen för https://forwardemail.net:4000 är fasad från och med 1 januari 2021.

autentisering

Alla slutpunkter kräver din API-nyckel ställas in som "användarnamn"-värdet för begäran Grundläggande auktorisation rubrik. Oroa dig inte – exempel ges nedan för dig om du inte är säker på vad detta är.

fel

Om några fel uppstår kommer svarstypen för API-begäran att innehålla ett detaljerat felmeddelande.

Kodanamn
200OK
400Dålig förfrågan
401Obehörig
403Förbjuden
404Hittades inte
429För många förfrågningar
500internt serverfel
501Ej implementerad
502Dålig gateway
503Tjänsten är inte tillgänglig
504Gateway Time-out
Dricks: Om du får en 5xx-statuskod (vilket inte borde hända), vänligen kontakta oss på api@forwardemail.net och vi hjälper dig att lösa ditt problem omedelbart.

Lokalisering

Vår tjänst är översatt till över 25 olika språk. Alla API-svarsmeddelanden översätts till den senast upptäckta lokalen för användaren som gör API-begäran. Du kan åsidosätta detta genom att skicka en anpassad Accept-Language rubrik. Testa gärna med hjälp av rullgardinsmenyn för språk längst ner på denna sida.

Paginering

Om du vill bli meddelad när paginering är tillgänglig, vänligen maila api@forwardemail.net.

konto

Skapa konto

POST /v1/account

KroppsparameterNödvändigTypBeskrivning
emailJaString (e-post)E-postadress
passwordJaSträngLösenord

Exempelförfrågan:

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

Hämta konto

GET /v1/account

Exempelförfrågan:

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

Uppdatera konto

PUT /v1/account

KroppsparameterNödvändigTypBeskrivning
emailNejString (e-post)E-postadress
given_nameNejSträngFörnamn
family_nameNejSträngEfternamn
avatar_urlNejSträng (URL)Länk till avatarbild

Exempelförfrågan:

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

domäner

Dricks: Domänändpunkter med ett domännamn /v1/domains/:domain_name eftersom deras sökväg är utbytbara med en domäns ID :domain_id. Detta innebär att du kan referera till domänen med antingen dess name eller id värde.

Lista domäner

GET /v1/domains

Querystring-parameterNödvändigTypBeskrivning
nameNejString (RegExp stöds)Sök efter domäner efter namn
aliasNejString (RegExp stöds)Sök efter domäner efter aliasnamn
recipientNejString (RegExp stöds)Sök efter domäner efter mottagare

Exempelförfrågan:

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

Skapa domän

POST /v1/domains

KroppsparameterNödvändigTypBeskrivning
domainJaString (FQDN eller IP)Fullt kvalificerat domännamn ("FQDN") eller IP-adress
planNejSträng (många)Plantyp (måste vara "free", "enhanced_protection", eller "team", har som standard "free" eller användarens nuvarande betalda plan om det finns en)
catchallNejSträng (avgränsade e-postadresser) eller booleskSkapa ett förvalt catch-all-alias, som standard true (om true den kommer att använda API-användarens e-postadress som mottagare, och om false ingen catch-all kommer att skapas). Om en sträng skickas är det en avgränsad lista med e-postadresser som ska användas som mottagare (avgränsade med radbrytning, mellanslag och/eller komma)
has_adult_content_protectionNejBooleanHuruvida skydd av barnförbjudet innehåll ska aktiveras av Spam Scanner på den här domänen
has_phishing_protectionNejBooleanOm du ska aktivera skydd mot nätfiske av skräppostskannern på den här domänen
has_executable_protectionNejBooleanOm körbart skydd ska aktiveras av Spam Scanner på den här domänen
has_virus_protectionNejBooleanOm du vill aktivera skräppostscanner-virusskydd på den här domänen
has_recipient_verificationNejBooleanGlobal domän standard för om aliasmottagare ska behöva klicka på en e-postverifieringslänk för att e-post ska flöda igenom

Exempelförfrågan:

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

Hämta domän

GET /v1/domains/example.com

Exempelförfrågan:

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

Verifiera domänregister

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

Exempelförfrågan:

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

Uppdatera domän

PUT /v1/domains/example.com

KroppsparameterNödvändigTypBeskrivning
smtp_portNejSträng eller nummerAnpassad port att konfigurera för SMTP-vidarebefordran (standard är "25")
has_adult_content_protectionNejBooleanHuruvida skydd av barnförbjudet innehåll ska aktiveras av Spam Scanner på den här domänen
has_phishing_protectionNejBooleanOm du ska aktivera skydd mot nätfiske av skräppostskannern på den här domänen
has_executable_protectionNejBooleanOm körbart skydd ska aktiveras av Spam Scanner på den här domänen
has_virus_protectionNejBooleanOm du vill aktivera skräppostscanner-virusskydd på den här domänen
has_recipient_verificationNejBooleanGlobal domän standard för om aliasmottagare ska behöva klicka på en e-postverifieringslänk för att e-post ska flöda igenom

Exempelförfrågan:

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

Radera domän

DELETE /v1/domains/:domain_name

Exempelförfrågan:

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

Inbjudningskort

Acceptera domäninbjudan

GET /v1/domains/:domain_name/invites

Exempelförfrågan:

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

Skapa domäninbjudan

POST /v1/domains/example.com/invites

KroppsparameterNödvändigTypBeskrivning
emailJaString (e-post)E-postadress för att bjuda in till listan med domänmedlemmar
groupJaSträng (många)Grupp att lägga till användaren till domänmedlemskapet med (kan vara en av "admin" eller "user")

Exempelförfrågan:

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

Ta bort domäninbjudan

DELETE /v1/domains/:domain_name/invites

KroppsparameterNödvändigTypBeskrivning
emailJaString (e-post)E-postadress som ska tas bort från listan över domänmedlemmar

Exempelförfrågan:

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

medlemmar

Uppdatera domänmedlem

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

KroppsparameterNödvändigTypBeskrivning
groupJaSträng (många)Grupp att uppdatera användaren till domänmedlemskapet med (kan vara en av "admin" eller "user")

Exempelförfrågan:

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

Ta bort domänmedlem

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

Exempelförfrågan:

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

alias

Lista domänalias

GET /v1/domains/example.com/aliases

Querystring-parameterNödvändigTypBeskrivning
nameNejString (RegExp stöds)Sök efter alias i en domän efter namn
recipientNejString (RegExp stöds)Sök efter alias i en domän efter mottagare

Exempelförfrågan:

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

Skapa nytt domänalias

POST /v1/domains/example.com/aliases

KroppsparameterNödvändigTypBeskrivning
nameJaSträngAlias namn
recipientsJaSträng eller arrayLista över mottagare (måste vara radbrytning / mellanslag / kommaseparerad sträng eller array med giltiga e-postadresser, fullt kvalificerade domännamn ("FQDN"), IP-adresser och / eller webbhook-webbadresser)
descriptionNejSträngAlias beskrivning
labelsNejSträng eller arrayLista över etiketter (måste vara radbrytning / mellanslag / kommaseparerad sträng eller array)
has_recipient_verificationNejBooleanHuruvida det ska aktiveras för att kräva att mottagarna klickar på en e-postverifieringslänk för att e-post ska flöda igenom (standard för domänens inställning om det inte uttryckligen anges i förfrågans brödtext)
is_enabledNejBooleanHuruvida att aktivera detta alias (om det är inaktiverat kommer e-postmeddelanden att dirigeras ingenstans men returnera framgångsrika statuskoder)

Exempelförfrågan:

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

Hämta domänalias

Du kan hämta ett domänalias med antingen dess id eller dess name värde.

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

Exempelförfrågan:

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

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

Exempelförfrågan:

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

Uppdatera domänalias

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

KroppsparameterNödvändigTypBeskrivning
nameNejSträngAlias namn
recipientsJaSträng eller arrayLista över mottagare (måste vara radbrytning / mellanslag / kommaseparerad sträng eller array med giltiga e-postadresser, fullt kvalificerade domännamn ("FQDN"), IP-adresser och / eller webbhook-webbadresser)
descriptionNejSträngAlias beskrivning
labelsNejSträng eller arrayLista över etiketter (måste vara radbrytning / mellanslag / kommaseparerad sträng eller array)
has_recipient_verificationNejBooleanHuruvida det ska aktiveras för att kräva att mottagarna klickar på en e-postverifieringslänk för att e-post ska flöda igenom (standard för domänens inställning om det inte uttryckligen anges i förfrågans brödtext)
is_enabledNejBooleanHuruvida att aktivera detta alias (om det är inaktiverat kommer e-postmeddelanden att dirigeras ingenstans men returnera framgångsrika statuskoder)

Exempelförfrågan:

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

Radera domänalias

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

Exempelförfrågan:

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