Besoin de documents avec de vraies données et clés?

Inscrivez-vous ou connectez-vous simplement pour que vos clés API et vos données de compte réel soient renseignées ci-dessous.

Lisez notre politique de confidentialité et nos conditions

Pas intéressé? Cliquez ici pour continuer à lire

Nous avons créé une API pour l'accès programmatique aux domaines, alias et plus encore.

🤖

Documentation API

Accès programmatique à vos données

API de transfert d'e-mails

Table des matières

Bibliothèques

Pour le moment, nous n'avons pas encore publié de wrappers API, mais nous prévoyons de le faire dans un proche avenir. Envoyer un courriel àapi@forwardemail.net si vous souhaitez être averti lorsque le wrapper d'API d'un langage de programmation particulier est publié. En attendant, vous pouvez utiliser ces bibliothèques de requêtes HTTP recommandées dans votre application, ou simplement utiliserboucle comme dans les exemples ci-dessous.

Langue Bibliothèque
Rubis Faraday
Python demandes
Java OkHttp
PHP bouffer
Javascript superagent
Node.js superagent
Aller net / http
.NET RestSharp

URI de base

Le chemin URI de base HTTP actuel est:https://api.forwardemail.net. Le chemin URI de base HTTP hérité dehttps://forwardemail.net:4000 sera dépréciée le 1er janvier 2021.

Authentification

Tous les points finaux nécessitent votreclé API gratuite 🎉 à définir comme valeur "nom d'utilisateur" de la requêteAutorisation de base entête. Ne vous inquiétez pas - des exemples sont fournis ci-dessous pour vous si vous n'êtes pas sûr de ce que c'est.

les erreurs

En cas d'erreur, le corps de réponse de la demande d'API contiendra un message d'erreur détaillé. En plus d'avoir plus de dix ans d'expérience dans la rédaction et la documentation d'API, elles ont été inspirées parStripe's belle documentation API quand nous avons conçu la nôtre 😄.

Code Nom
200 D'accord
400 Mauvaise Demande
401 Non autorisé
403 Interdit
404 Pas trouvé
429 Trop de demandes
500 Erreur Interne du Serveur
501 Pas mis en œuvre
502 Mauvaise passerelle
503 Service indisponible
504 Délai d'expiration de la passerelle
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.

Localisation

Notre service est traduit dans plus de 25 langues différentes. Tous les messages de réponse de l'API sont traduits dans les derniers paramètres régionaux détectés de l'utilisateur effectuant la demande d'API. Vous pouvez remplacer cela en transmettant une valeur personnaliséeAccept-Language entête. N'hésitez pas à l'essayer en utilisant la liste déroulante des langues en bas de cette page.

Pagination

Si vous souhaitez être averti lorsque la pagination est disponible, veuillez envoyer un e-mailapi@forwardemail.net.

Compte

Créer un compte

POST /v1/account

Paramètre de corps Obligatoire Type La description
email Oui Chaîne (e-mail) Adresse électronique
password Oui Chaîne Mot de passe

Exemple de demande:

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

Example Response:

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Password was invalid."
}

Récupérer le compte

GET /v1/account

Exemple de demande:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Compte mis à jour

PUT /v1/account

Paramètre de corps Obligatoire Type La description
email Non Chaîne (e-mail) Adresse électronique
given_name Non Chaîne Prénom
family_name Non Chaîne Nom de famille
avatar_url Non Chaîne (URL) Lien vers l'image de l'avatar

Exemple de demande:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Domaines

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.

Répertorier les domaines

GET /v1/domains

Paramètre de chaîne de requête Obligatoire Type La description
name Non Chaîne (RegExp pris en charge) Rechercher des domaines par nom
alias Non Chaîne (RegExp pris en charge) Rechercher des domaines par nom d'alias
recipient Non Chaîne (RegExp pris en charge) Rechercher des domaines par destinataire

Exemple de demande:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Créer un domaine

POST /v1/domains

Paramètre de corps Obligatoire Type La description
domain Oui Chaîne (FQDN ou IP) Nom de domaine complet ("FQDN") ou adresse IP
plan Non Chaîne (énumérable) Type de plan (doit être"free","enhanced_protection", ou"team", par défaut à"free")
catchall Non String (delimited email addresses) or Boolean Create a default catch-all alias, defaults to true (if true it will use the API user's email address as a recipient, and if false no catch-all will be created). If a String is passed, then it is a delimited list of email addresses to use as recipients (separated by line break, space, and/or comma)

Exemple de demande:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Récupérer un domaine

GET /v1/domains/example.com

Exemple de demande:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Vérifier les enregistrements de domaine

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

Exemple de demande:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Mettre à jour le domaine

PUT /v1/domains/example.com

Paramètre de corps Obligatoire Type La description
smtp_port Non Chaîne ou nombre Port personnalisé à configurer pour le transfert SMTP (la valeur par défaut est"25")

Exemple de demande:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Supprimer un domaine

DELETE /v1/domains/:domain_name

Exemple de demande:

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

Invite

Accepter l'invitation au domaine

GET /v1/domains/:domain_name/invites

Exemple de demande:

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

Créer une invitation de domaine

POST /v1/domains/example.com/invites

Paramètre de corps Obligatoire Type La description
email Oui Chaîne (e-mail) Adresse e-mail pour inviter à la liste des membres du domaine
group Oui Chaîne (énumérable) Groupe pour ajouter l'utilisateur à l'appartenance au domaine (peut être l'un des"admin" ou"user")

Exemple de demande:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Supprimer l'invitation au domaine

DELETE /v1/domains/:domain_name/invites

Paramètre de corps Obligatoire Type La description
email Oui Chaîne (e-mail) Adresse e-mail à supprimer de la liste des membres du domaine

Exemple de demande:

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

Membres

Mettre à jour le membre du domaine

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

Paramètre de corps Obligatoire Type La description
group Oui Chaîne (énumérable) Groupe pour mettre à jour l'utilisateur vers l'appartenance au domaine (peut être l'un des"admin" ou"user")

Exemple de demande:

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

Supprimer le membre du domaine

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

Exemple de demande:

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

Alias

Récupérer les alias de domaine

GET /v1/domains/example.com/aliases

Exemple de demande:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Créer un nouvel alias de domaine

POST /v1/domains/example.com/aliases

Paramètre de corps Obligatoire Type La description
name Oui Chaîne Surnom
recipients Oui Chaîne ou tableau Liste des destinataires (doit être un saut de ligne / un espace / une chaîne séparée par des virgules d'adresses e-mail valides, des noms de domaine complets ("FQDN"), des adresses IP et / ou des URL de webhook)
description Non Chaîne Description de l'alias
labels Non Chaîne ou tableau Liste des étiquettes (doit être un saut de ligne / espace / chaîne ou tableau séparé par des virgules)
is_enabled Non Booléen Indique s'il faut activer ou non cet alias (s'il est désactivé, les e-mails ne seront acheminés nulle part mais renverront les codes d'état réussis)

Exemple de demande:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Mettre à jour l'alias de domaine

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

Paramètre de corps Obligatoire Type La description
name Non Chaîne Surnom
recipients Oui Chaîne ou tableau Liste des destinataires (doit être un saut de ligne / un espace / une chaîne séparée par des virgules d'adresses e-mail valides, des noms de domaine complets ("FQDN"), des adresses IP et / ou des URL de webhook)
description Non Chaîne Description de l'alias
labels Non Chaîne ou tableau Liste des étiquettes (doit être un saut de ligne / espace / chaîne ou tableau séparé par des virgules)
is_enabled Non Booléen Indique s'il faut activer ou non cet alias (s'il est désactivé, les e-mails ne seront acheminés nulle part mais renverront les codes d'état réussis)

Exemple de demande:

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

Supprimer l'alias de domaine

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

Exemple de demande:

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