Documenten nodig met echte gegevens en sleutels?

Meld u aan of log in om uw API-sleutels en echte accountgegevens hieronder in te vullen.

U gaat akkoord met ons privacybeleid en onze voorwaarden .

Niet geïnteresseerd? Klik hier om verder te lezen

Inhoudsopgave

We hebben een API gemaakt voor programmatische toegang tot domeinen, aliassen en meer.

API-documentatie

Programmatische toegang tot uw gegevens

API voor het doorsturen van e-mail

Inhoudsopgave

Bibliotheken

Op dit moment hebben we nog geen API-wrappers uitgebracht, maar we zijn van plan dit in de nabije toekomst te doen. Stuur een email naar api@forwardemail.net als u op de hoogte wilt worden gehouden wanneer de API-wrapper van een bepaalde programmeertaal wordt vrijgegeven. Ondertussen kunt u deze aanbevolen HTTP-verzoekbibliotheken in uw toepassing gebruiken, of gewoon krullen zoals in de onderstaande voorbeelden.

TaalBibliotheek
RobijnFaraday
Pythonverzoeken
JavaOkHttp
PHPslikken
JavaScriptsuperagent
Node.jssuperagent
Gaannet / http
.NETRestSharp

Basis-URI

Het huidige HTTP-basis-URI-pad is: https://api.forwardemail.net. Het verouderde HTTP-basis-URI-pad van https://forwardemail.net:4000 wordt beëindigd per 1 januari 2021.

Authenticatie

Voor alle eindpunten is uw API sleutel in te stellen als de "gebruikersnaam" waarde van de aanvraag's Basisautorisatie kop. Maakt u zich geen zorgen - hieronder vindt u voorbeelden als u niet zeker weet wat dit is.

Fouten

Als er fouten optreden, bevat de antwoordtekst van het API-verzoek een gedetailleerd foutbericht.

CodeNaam
200OK
400Foutief verzoek
401Ongeautoriseerd
403Verboden
404Niet gevonden
429Te veel verzoeken
500Interne Server Fout
501Niet geïmplementeerd
502Slechte gateway
503Service onbeschikbaar
504Time-out van gateway
Tip: Als u een 5xx-statuscode ontvangt (wat niet zou moeten gebeuren), neem dan contact met ons op via: api@forwardemail.net en we zullen u helpen om uw probleem onmiddellijk op te lossen.

Lokalisatie

Onze service is vertaald in meer dan 25 verschillende talen. Alle API-antwoordberichten worden vertaald naar de laatst gedetecteerde landinstelling van de gebruiker die het API-verzoek doet. Je kunt dit overschrijven door een gewoonte door te geven Accept-Language kop. Voel je vrij om het uit te proberen met behulp van de taal drop-down onderaan deze pagina.

Paginering

Als u op de hoogte wilt worden gehouden wanneer paginering beschikbaar is, stuur dan een e-mail naar api@forwardemail.net.

Account

Account aanmaken

POST /v1/account

LichaamsparameterVerplichtTypeOmschrijving
emailJaTekenreeks (e-mail)E-mailadres
passwordJaDraadWachtwoord

Voorbeeldaanvraag:

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

Account ophalen

GET /v1/account

Voorbeeldaanvraag:

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

Account bijwerken

PUT /v1/account

LichaamsparameterVerplichtTypeOmschrijving
emailNeeTekenreeks (e-mail)E-mailadres
given_nameNeeDraadVoornaam
family_nameNeeDraadAchternaam
avatar_urlNeeTekenreeks (URL)Link naar avatarafbeelding

Voorbeeldaanvraag:

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

Domeinen

Tip: Domeineindpunten met de naam van een domein /v1/domains/:domain_name omdat hun pad uitwisselbaar is met de ID van een domein :domain_id. Dit betekent dat u naar het domein kunt verwijzen door ofwel zijn name of id waarde.

Lijst domeinen

GET /v1/domains

Querystring-parameterVerplichtTypeOmschrijving
nameNeeString (RegExp ondersteund)Zoek naar domeinen op naam
aliasNeeString (RegExp ondersteund)Zoek naar domeinen op aliasnaam
recipientNeeString (RegExp ondersteund)Zoek naar domeinen op ontvanger

Voorbeeldaanvraag:

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

Domein aanmaken

POST /v1/domains

LichaamsparameterVerplichtTypeOmschrijving
domainJaString (FQDN of IP)Volledig gekwalificeerde domeinnaam ("FQDN") of IP-adres
planNeeString (opsommbaar)Abonnementstype (moet zijn "free", "enhanced_protection", of "team", standaard ingesteld op "free" of het huidige betaalde abonnement van de gebruiker, indien aanwezig)
catchallNeeString (gescheiden e-mailadressen) of BooleanMaak een standaard catch-all alias, standaard op true (als true het zal het e-mailadres van de API-gebruiker als ontvanger gebruiken, en als: false er wordt geen catch-all gemaakt). Als een tekenreeks wordt doorgegeven, is het een afgebakende lijst met e-mailadressen die als ontvangers kunnen worden gebruikt (gescheiden door regeleinde, spatie en/of komma)
has_adult_content_protectionNeeBooleaansOf u de bescherming van inhoud voor volwassenen met Spam Scanner op dit domein wilt inschakelen
has_phishing_protectionNeeBooleaansOf u de phishing-beveiliging van Spam Scanner op dit domein wilt inschakelen
has_executable_protectionNeeBooleaansOf de uitvoerbare bescherming van Spam Scanner op dit domein moet worden ingeschakeld
has_virus_protectionNeeBooleaansOf u Spam Scanner-virusbescherming op dit domein wilt inschakelen
has_recipient_verificationNeeBooleaansAlgemene domeinstandaard om te bepalen of aliasontvangers op een e-mailverificatielink moeten klikken om e-mails door te laten stromen

Voorbeeldaanvraag:

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

Domein ophalen

GET /v1/domains/example.com

Voorbeeldaanvraag:

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

Controleer domeinrecords

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

Voorbeeldaanvraag:

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

Domein updaten

PUT /v1/domains/example.com

LichaamsparameterVerplichtTypeOmschrijving
smtp_portNeeTekenreeks of nummerAangepaste poort om te configureren voor SMTP-forwarding (standaard is "25")
has_adult_content_protectionNeeBooleaansOf u de bescherming van inhoud voor volwassenen met Spam Scanner op dit domein wilt inschakelen
has_phishing_protectionNeeBooleaansOf u de phishing-beveiliging van Spam Scanner op dit domein wilt inschakelen
has_executable_protectionNeeBooleaansOf de uitvoerbare bescherming van Spam Scanner op dit domein moet worden ingeschakeld
has_virus_protectionNeeBooleaansOf u Spam Scanner-virusbescherming op dit domein wilt inschakelen
has_recipient_verificationNeeBooleaansAlgemene domeinstandaard om te bepalen of aliasontvangers op een e-mailverificatielink moeten klikken om e-mails door te laten stromen

Voorbeeldaanvraag:

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

Domein verwijderen

DELETE /v1/domains/:domain_name

Voorbeeldaanvraag:

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

Nodigt uit

Domeinuitnodiging accepteren

GET /v1/domains/:domain_name/invites

Voorbeeldaanvraag:

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

Maak een domeinuitnodiging

POST /v1/domains/example.com/invites

LichaamsparameterVerplichtTypeOmschrijving
emailJaTekenreeks (e-mail)E-mailadres om uit te nodigen voor de ledenlijst van het domein
groupJaString (opsommbaar)Groep om de gebruiker aan het domeinlidmaatschap toe te voegen (kan een van zijn) "admin" of "user")

Voorbeeldaanvraag:

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

Domeinuitnodiging verwijderen

DELETE /v1/domains/:domain_name/invites

LichaamsparameterVerplichtTypeOmschrijving
emailJaTekenreeks (e-mail)E-mailadres om te verwijderen uit de ledenlijst van het domein

Voorbeeldaanvraag:

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

Leden

Domeinlid updaten

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

LichaamsparameterVerplichtTypeOmschrijving
groupJaString (opsommbaar)Groep om de gebruiker bij te werken naar het domeinlidmaatschap met (kan een van zijn) "admin" of "user")

Voorbeeldaanvraag:

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

Domeinlid verwijderen

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

Voorbeeldaanvraag:

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

Aliassen

Domeinaliassen weergeven

GET /v1/domains/example.com/aliases

Querystring-parameterVerplichtTypeOmschrijving
nameNeeString (RegExp ondersteund)Zoek op naam naar aliassen in een domein
recipientNeeString (RegExp ondersteund)Zoek naar aliassen in een domein op ontvanger

Voorbeeldaanvraag:

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

Maak een nieuwe domeinalias aan

POST /v1/domains/example.com/aliases

LichaamsparameterVerplichtTypeOmschrijving
nameJaDraadAlias naam
recipientsJaString of ArrayLijst met ontvangers (moet een regelafbreking / spatie / door komma's gescheiden string of array van geldige e-mailadressen, volledig gekwalificeerde domeinnamen ("FQDN"), IP-adressen en / of webhook-URL's zijn)
descriptionNeeDraadAliasbeschrijving
labelsNeeString of ArrayLijst met labels (moet een regeleinde / spatie / door komma's gescheiden string of array zijn)
has_recipient_verificationNeeBooleaansOf ontvangers moeten worden verplicht om op een e-mailverificatielink te klikken om e-mails door te laten stromen (standaard ingesteld op de domeininstelling als dit niet expliciet is ingesteld in de hoofdtekst van het verzoek)
is_enabledNeeBooleaansOf deze alias moet worden uitgeschakeld (als deze optie is uitgeschakeld, worden e-mails nergens naartoe gestuurd, maar worden succesvolle statuscodes geretourneerd)

Voorbeeldaanvraag:

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

Domeinalias ophalen

U kunt een domeinalias ophalen door ofwel zijn id of het is name waarde.

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

Voorbeeldaanvraag:

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

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

Voorbeeldaanvraag:

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

Domeinalias updaten

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

LichaamsparameterVerplichtTypeOmschrijving
nameNeeDraadAlias naam
recipientsJaString of ArrayLijst met ontvangers (moet een regelafbreking / spatie / door komma's gescheiden string of array van geldige e-mailadressen, volledig gekwalificeerde domeinnamen ("FQDN"), IP-adressen en / of webhook-URL's zijn)
descriptionNeeDraadAliasbeschrijving
labelsNeeString of ArrayLijst met labels (moet een regeleinde / spatie / door komma's gescheiden string of array zijn)
has_recipient_verificationNeeBooleaansOf ontvangers moeten worden verplicht om op een e-mailverificatielink te klikken om e-mails door te laten stromen (standaard ingesteld op de domeininstelling als dit niet expliciet is ingesteld in de hoofdtekst van het verzoek)
is_enabledNeeBooleaansOf deze alias moet worden uitgeschakeld (als deze optie is uitgeschakeld, worden e-mails nergens naartoe gestuurd, maar worden succesvolle statuscodes geretourneerd)

Voorbeeldaanvraag:

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

Domeinalias verwijderen

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

Voorbeeldaanvraag:

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