Documenten nodig met echte gegevens en sleutels?

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

Lees ons privacybeleid en onze voorwaarden

Niet geïnteresseerd? Klik hier om verder te lezen

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. Verzend een email naarapi@forwardemail.net als u een melding wilt ontvangen wanneer de API-wrapper van een bepaalde programmeertaal wordt vrijgegeven. Ondertussen kunt u deze aanbevolen HTTP-aanvraagbibliotheken in uw toepassing gebruiken of gewoon gebruikenkrullen zoals in de onderstaande voorbeelden.

Taal Bibliotheek
Robijn Faraday
Python verzoeken
Java OkHttp
Php slikken
JavaScript superagent
Node.js superagent
Gaan net / http
.NETTO RestSharp

Basis-URI

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

Authenticatie

Voor alle eindpunten is uwgratis API-sleutel 🎉 to be set as the "username" value of the request's Basisautorisatie koptekst. Maak u geen zorgen - hieronder vindt u voorbeelden als u niet zeker weet wat dit is.

Fouten

Als er fouten optreden, zal het antwoordgedeelte van het API-verzoek een gedetailleerd foutbericht bevatten. Naast meer dan tien jaar ervaring met het schrijven en documenteren van API's, werden ze geïnspireerd doorStripe beautiful API documentation when we crafted ours 😄.

Code Naam
200 OK
400 Foutief verzoek
401 Ongeautoriseerd
403 Verboden
404 Niet gevonden
429 Te veel verzoeken
500 Interne Server Fout
501 Niet geïmplementeerd
502 Slechte gateway
503 Service onbeschikbaar
504 Time-out van gateway
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.

Lokalisatie

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

Paginering

Als je een melding wilt ontvangen wanneer paginering beschikbaar is, stuur dan een e-mailapi@forwardemail.net.

Account

Account aanmaken

POST /v1/account

Lichaamsparameter Verplicht Type Omschrijving
email Ja Tekenreeks (e-mail) E-mailadres
password Ja Draad Wachtwoord

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

Lichaamsparameter Verplicht Type Omschrijving
email Nee Tekenreeks (e-mail) E-mailadres
given_name Nee Draad Voornaam
family_name Nee Draad Achternaam
avatar_url Nee Tekenreeks (URL) Link naar avatarafbeelding

Voorbeeldaanvraag:

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

Domeinen

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.

Lijst domeinen

GET /v1/domains

Querystring-parameter Verplicht Type Omschrijving
name Nee String (RegExp ondersteund) Zoek naar domeinen op naam
alias Nee String (RegExp ondersteund) Zoek naar domeinen op aliasnaam
recipient Nee String (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

Lichaamsparameter Verplicht Type Omschrijving
domain Ja String (FQDN of IP) Volledig gekwalificeerde domeinnaam ("FQDN") of IP-adres
plan Nee String (opsommbaar) Plan type (moet zijn"free","enhanced_protection", of"team", standaard"free")
catchall Nee String (gescheiden e-mailadressen) of Boolean Maak een standaard catch-all alias, standaard ingesteld optrue (alstrue het zal het e-mailadres van de API-gebruiker als ontvanger gebruiken, en offalse er wordt geen catch-all gemaakt). Als een tekenreeks wordt doorgegeven, is het een lijst met gescheiden e-mailadressen die als ontvangers kunnen worden gebruikt (gescheiden door regeleinde, spatie en / of komma)

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

Lichaamsparameter Verplicht Type Omschrijving
smtp_port Nee Tekenreeks of nummer Aangepaste poort om te configureren voor SMTP-doorsturing (standaard is"25")

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

Lichaamsparameter Verplicht Type Omschrijving
email Ja Tekenreeks (e-mail) E-mailadres om uit te nodigen voor de ledenlijst van het domein
group Ja String (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

Lichaamsparameter Verplicht Type Omschrijving
email Ja Tekenreeks (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

Lichaamsparameter Verplicht Type Omschrijving
group Ja String (opsommbaar) Groep om de gebruiker te updaten 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

Haal domeinaliassen op

GET /v1/domains/example.com/aliases

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

Lichaamsparameter Verplicht Type Omschrijving
name Ja Draad Alias naam
recipients Ja String of Array Lijst 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)
description Nee Draad Aliasbeschrijving
labels Nee String of Array Lijst met labels (moet een regeleinde / spatie / door komma's gescheiden string of array zijn)
is_enabled Nee Booleaans Of 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 updaten

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

Lichaamsparameter Verplicht Type Omschrijving
name Nee Draad Alias naam
recipients Ja String of Array Lijst 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)
description Nee Draad Aliasbeschrijving
labels Nee String of Array Lijst met labels (moet een regeleinde / spatie / door komma's gescheiden string of array zijn)
is_enabled Nee Booleaans Of 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: