Benötigen Sie Dokumente mit echten Daten und Schlüsseln?
Melden Sie sich einfach an oder melden Sie sich an, damit Ihre API-Schlüssel und echten Kontodaten unten aufgeführt werden.
Wir haben eine API für den programmgesteuerten Zugriff auf Domänen, Aliase und mehr erstellt.
API-Dokumentation
Programmatischer Zugriff auf Ihre DatenE-Mail-Weiterleitungs-API
Inhaltsverzeichnis
- Bibliotheken
- Basis-URI
- Authentifizierung
- Fehler
- Lokalisierung
- Seitennummerierung
- Konto
- Domänen
- Lädt ein
- Mitglieder
- Aliase
Bibliotheken
Derzeit haben wir noch keine API-Wrapper veröffentlicht, aber wir planen dies in naher Zukunft. Sende eine Email anapi@forwardemail.net Wenn Sie benachrichtigt werden möchten, wenn der API-Wrapper einer bestimmten Programmiersprache veröffentlicht wird. In der Zwischenzeit können Sie diese empfohlenen HTTP-Anforderungsbibliotheken in Ihrer Anwendung verwenden oder einfach verwendenlocken wie in den folgenden Beispielen.
Sprache | Bibliothek |
---|---|
Rubin | Faraday |
Python | Anfragen |
Java | OkHttp |
PHP | fressen |
JavaScript | Superagent |
Node.js | Superagent |
Gehen | net / http |
.NETZ | RestSharp |
Basis-URI
Der aktuelle HTTP-Basis-URI-Pfad lautet:https://api.forwardemail.net
. Der ältere HTTP-Basis-URI-Pfad vonhttps://forwardemail.net:4000
is deprecated as of January 1, 2021.
Authentifizierung
Alle Endpunkte erfordern Ihrekostenloser API-Schlüssel 🎉 to be set as the "username" value of the request's Grundautorisierung Header. Keine Sorge - unten finden Sie Beispiele, wenn Sie sich nicht sicher sind, was dies ist.
Fehler
Wenn Fehler auftreten, enthält der Antworttext der API-Anforderung eine detaillierte Fehlermeldung. Neben über zehn Jahren Erfahrung im Schreiben und Dokumentieren von APIs wurden wir von inspiriertStreifen beautiful API documentation when we crafted ours 😄.
Code | Name |
---|---|
200 | in Ordnung |
400 | Ungültige Anforderung |
401 | Nicht autorisiert |
403 | verboten |
404 | Nicht gefunden |
429 | Zu viele Anfragen |
500 | interner Serverfehler |
501 | Nicht implementiert |
502 | Schlechtes Gateway |
503 | Dienst nicht verfügbar |
504 | Gateway-Zeitüberschreitung |
Lokalisierung
Unser Service wird in über 25 verschiedene Sprachen übersetzt. Alle API-Antwortnachrichten werden in das zuletzt erkannte Gebietsschema des Benutzers übersetzt, der die API-Anforderung stellt. Sie können dies überschreiben, indem Sie eine benutzerdefinierte Datei übergebenAccept-Language
Header. Probieren Sie es einfach mit dem Sprach-Dropdown-Menü unten auf dieser Seite aus.
Seitennummerierung
Wenn Sie benachrichtigt werden möchten, wenn eine Paginierung verfügbar ist, senden Sie bitte eine E-Mailapi@forwardemail.net.
Konto
Konto erstellen
POST /v1/account
Körperparameter | Erforderlich | Art | Beschreibung |
---|---|---|---|
email |
Ja | Zeichenfolge (E-Mail) | E-Mail-Addresse |
password |
Ja | String | Passwort |
Beispielanforderung:
curl -X POST https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
Konto abrufen
GET /v1/account
Beispielanforderung:
curl -X GET https://api.forwardemail.net/v1/account \
-u API_TOKEN:
Aktualisiere den Account
PUT /v1/account
Körperparameter | Erforderlich | Art | Beschreibung |
---|---|---|---|
email |
Nein | Zeichenfolge (E-Mail) | E-Mail-Addresse |
given_name |
Nein | String | Vorname |
family_name |
Nein | String | Nachname |
avatar_url |
Nein | Zeichenfolge (URL) | Link zum Avatar-Bild |
Beispielanforderung:
curl -X PUT https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
Domänen
/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.
Domains auflisten
GET /v1/domains
Querystring-Parameter | Erforderlich | Art | Beschreibung |
---|---|---|---|
name |
Nein | String (RegExp unterstützt) | Suchen Sie nach Domains nach Namen |
alias |
Nein | String (RegExp unterstützt) | Suchen Sie nach Domains anhand des Aliasnamens |
recipient |
Nein | String (RegExp unterstützt) | Suche nach Domains nach Empfänger |
Beispielanforderung:
curl -X GET https://api.forwardemail.net/v1/domains \
-u API_TOKEN:
Domain erstellen
POST /v1/domains
Körperparameter | Erforderlich | Art | Beschreibung |
---|---|---|---|
domain |
Ja | Zeichenfolge (FQDN oder IP) | Vollqualifizierter Domainname ("FQDN") oder IP-Adresse |
plan |
Nein | String (aufzählbar) | Planart (muss sein"free" ,"enhanced_protection" , oder"team" Standardmäßig"free" ) |
catchall |
Nein | Zeichenfolge (begrenzte E-Mail-Adressen) oder Boolescher Wert | Erstellen Sie standardmäßig einen Standard-Catch-All-Aliastrue (wenntrue Es wird die E-Mail-Adresse des API-Benutzers als Empfänger verwendet, und wennfalse es wird kein Allheilmittel erstellt). Wenn eine Zeichenfolge übergeben wird, handelt es sich um eine begrenzte Liste von E-Mail-Adressen, die als Empfänger verwendet werden sollen (getrennt durch Zeilenumbruch, Leerzeichen und / oder Komma). |
Beispielanforderung:
curl -X POST https://api.forwardemail.net/v1/domains \
-u API_TOKEN: \
-d domain=example.com \
-d plan=free
Domain abrufen
GET /v1/domains/example.com
Beispielanforderung:
curl -X GET https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
Überprüfen Sie die Domäneneinträge
GET /v1/domains/example.com/verify-records
Beispielanforderung:
curl -X GET https://api.forwardemail.net/v1/domains/example.com/verify-records \
-u API_TOKEN:
Domain aktualisieren
PUT /v1/domains/example.com
Körperparameter | Erforderlich | Art | Beschreibung |
---|---|---|---|
smtp_port |
Nein | Zeichenfolge oder Nummer | Benutzerdefinierter Port zum Konfigurieren für die SMTP-Weiterleitung (Standard ist"25" ) |
Beispielanforderung:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
Domain löschen
DELETE /v1/domains/:domain_name
Beispielanforderung:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
-u API_TOKEN:
Lädt ein
Domaineinladung annehmen
GET /v1/domains/:domain_name/invites
Beispielanforderung:
curl -X GET https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
Domaineinladung erstellen
POST /v1/domains/example.com/invites
Körperparameter | Erforderlich | Art | Beschreibung |
---|---|---|---|
email |
Ja | Zeichenfolge (E-Mail) | E-Mail-Adresse zum Einladen in die Liste der Domainmitglieder |
group |
Ja | String (aufzählbar) | Gruppe, mit der der Benutzer zur Domänenmitgliedschaft hinzugefügt werden soll (kann eine von sein"admin" oder"user" ) |
Beispielanforderung:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
-u API_TOKEN: \
-d "email=user%40gmail.com" \
-d group=admin
Domaineinladung entfernen
DELETE /v1/domains/:domain_name/invites
Körperparameter | Erforderlich | Art | Beschreibung |
---|---|---|---|
email |
Ja | Zeichenfolge (E-Mail) | E-Mail-Adresse, die aus der Liste der Domainmitglieder entfernt werden soll |
Beispielanforderung:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
Mitglieder
Domain-Mitglied aktualisieren
PUT /v1/domains/example.com/members/:member_id
Körperparameter | Erforderlich | Art | Beschreibung |
---|---|---|---|
group |
Ja | String (aufzählbar) | Gruppe, mit der der Benutzer auf die Domänenmitgliedschaft aktualisiert werden soll (kann eine von sein"admin" oder"user" ) |
Beispielanforderung:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
-u API_TOKEN:
Domain-Mitglied entfernen
DELETE /v1/domains/:domain_name/members/:member_id
Beispielanforderung:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
-u API_TOKEN:
Aliase
Domain-Aliase abrufen
GET /v1/domains/example.com/aliases
Beispielanforderung:
curl -X GET https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
Erstellen Sie einen neuen Domain-Alias
POST /v1/domains/example.com/aliases
Körperparameter | Erforderlich | Art | Beschreibung |
---|---|---|---|
name |
Ja | String | Pseudonym |
recipients |
Ja | String oder Array | Liste der Empfänger (muss durch Zeilenumbruch / Leerzeichen / Komma getrennt sein. Zeichenfolge oder Array gültiger E-Mail-Adressen, vollqualifizierter Domänennamen ("FQDN"), IP-Adressen und / oder Webhook-URLs). |
description |
Nein | String | Alias Beschreibung |
labels |
Nein | String oder Array | Liste der Beschriftungen (muss durch Zeilenumbruch / Leerzeichen / Komma getrennt sein String oder Array) |
is_enabled |
Nein | Boolescher Wert | Gibt an, ob die Deaktivierung dieses Alias aktiviert werden soll (wenn diese Option deaktiviert ist, werden E-Mails nur an erfolgreiche Statuscodes weitergeleitet). |
Beispielanforderung:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
Aktualisieren Sie den Domain-Alias
PUT /v1/domains/example.com/aliases/:alias_id
Körperparameter | Erforderlich | Art | Beschreibung |
---|---|---|---|
name |
Nein | String | Pseudonym |
recipients |
Ja | String oder Array | Liste der Empfänger (muss durch Zeilenumbruch / Leerzeichen / Komma getrennt sein. Zeichenfolge oder Array gültiger E-Mail-Adressen, vollqualifizierter Domänennamen ("FQDN"), IP-Adressen und / oder Webhook-URLs). |
description |
Nein | String | Alias Beschreibung |
labels |
Nein | String oder Array | Liste der Beschriftungen (muss durch Zeilenumbruch / Leerzeichen / Komma getrennt sein String oder Array) |
is_enabled |
Nein | Boolescher Wert | Gibt an, ob die Deaktivierung dieses Alias aktiviert werden soll (wenn diese Option deaktiviert ist, werden E-Mails nur an erfolgreiche Statuscodes weitergeleitet). |
Beispielanforderung:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
-u API_TOKEN:
Domain-Alias löschen
DELETE /v1/domains/:domain_name/aliases/:alias_id
Beispielanforderung:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
-u API_TOKEN: