API voor het doorsturen van e-mail

Inhoudsopgave

• Bibliotheken
• Basis-URI
• Authenticatie
• Fouten
• Lokalisatie
• Paginering
• Account
  • Account aanmaken
  • Account ophalen
  • Account bijwerken
• Domeinen
  • Lijst domeinen
  • Domein aanmaken
  • Domein ophalen
  • Controleer domeinrecords
  • Domein updaten
  • Domein verwijderen
• Nodigt uit
  • Domeinuitnodiging accepteren
  • Maak een domeinuitnodiging
  • Domeinuitnodiging verwijderen
• Leden
  • Domeinlid updaten
  • Domeinlid verwijderen
• Aliassen
  • Domeinaliassen weergeven
  • Maak een nieuwe domeinalias aan
  • Domeinalias ophalen
  • Domeinalias updaten
  • Domeinalias verwijderen

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.

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

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.

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

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

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

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)	Abonnementstype (moet zijn "free", "enhanced_protection", of "team", standaard ingesteld op "free" of het huidige betaalde abonnement van de gebruiker, indien aanwezig)
catchall	Nee	String (gescheiden e-mailadressen) of Boolean	Maak 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_protection	Nee	Booleaans	Of u de bescherming van inhoud voor volwassenen met Spam Scanner op dit domein wilt inschakelen
has_phishing_protection	Nee	Booleaans	Of u de phishing-beveiliging van Spam Scanner op dit domein wilt inschakelen
has_executable_protection	Nee	Booleaans	Of de uitvoerbare bescherming van Spam Scanner op dit domein moet worden ingeschakeld
has_virus_protection	Nee	Booleaans	Of u Spam Scanner-virusbescherming op dit domein wilt inschakelen
has_recipient_verification	Nee	Booleaans	Algemene 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

Lichaamsparameter	Verplicht	Type	Omschrijving
smtp_port	Nee	Tekenreeks of nummer	Aangepaste poort om te configureren voor SMTP-forwarding (standaard is "25")
has_adult_content_protection	Nee	Booleaans	Of u de bescherming van inhoud voor volwassenen met Spam Scanner op dit domein wilt inschakelen
has_phishing_protection	Nee	Booleaans	Of u de phishing-beveiliging van Spam Scanner op dit domein wilt inschakelen
has_executable_protection	Nee	Booleaans	Of de uitvoerbare bescherming van Spam Scanner op dit domein moet worden ingeschakeld
has_virus_protection	Nee	Booleaans	Of u Spam Scanner-virusbescherming op dit domein wilt inschakelen
has_recipient_verification	Nee	Booleaans	Algemene 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

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 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-parameter	Verplicht	Type	Omschrijving
name	Nee	String (RegExp ondersteund)	Zoek op naam naar aliassen in een domein
recipient	Nee	String (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

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)
has_recipient_verification	Nee	Booleaans	Of 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_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 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

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)
has_recipient_verification	Nee	Booleaans	Of 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_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: