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.

Vous acceptez notre politique de confidentialité et nos conditions .

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

Table des matières

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

À l'heure actuelle, nous n'avons pas encore publié de wrappers d'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 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 utiliser boucle comme dans les exemples ci-dessous.

LangueBibliothèque
RubisFaraday
Pythondemandes
JavaOkHttp
PHPbouffer
Javascriptsuperagent
Node.jssuperagent
Allernet / http
.NETResteSharp

URI de base

Le chemin URI de base HTTP actuel est : https://api.forwardemail.net. L'ancien chemin d'URI de base HTTP de https://forwardemail.net:4000 est obsolète depuis le 1er janvier 2021.

Authentification

Tous les terminaux nécessitent votre Clé API à définir comme valeur "nom d'utilisateur" de la requête Autorisation 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

Si des erreurs se produisent, le corps de la réponse de la requête API contiendra un message d'erreur détaillé.

CodeNom
200OK
400Mauvaise Demande
401Non autorisé
403Interdit
404Pas trouvé
429Trop de demandes
500Erreur Interne du Serveur
501Pas mis en œuvre
502Mauvaise passerelle
503Service indisponible
504Délai d'expiration de la passerelle
Pointe: Si vous recevez un code de statut 5xx (ce qui ne devrait pas arriver), veuillez nous contacter à api@forwardemail.net et nous vous aiderons à résoudre votre problème immédiatement.

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 passant un personnalisé Accept-Language entête. N'hésitez pas à l'essayer en utilisant la liste déroulante des langues au bas de cette page.

Pagination

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

Compte

Créer un compte

POST /v1/account

Paramètre de corpsObligatoireTaperLa description
emailOuiChaîne (e-mail)Adresse électronique
passwordOuiChaîneMot de passe

Exemple de demande:

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

Récupérer le compte

GET /v1/account

Exemple de demande:

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

Compte mis à jour

PUT /v1/account

Paramètre de corpsObligatoireTaperLa description
emailNonChaîne (e-mail)Adresse électronique
given_nameNonChaînePrénom
family_nameNonChaîneNom de famille
avatar_urlNonChaî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"

Domaines

Pointe: Points de terminaison de domaine avec un nom de domaine /v1/domains/:domain_name car leur chemin est interchangeable avec l'ID d'un domaine :domain_id. Cela signifie que vous pouvez faire référence au domaine soit par son name ou id évaluer.

Répertorier les domaines

GET /v1/domains

Paramètre de chaîne de requêteObligatoireTaperLa description
nameNonChaîne (RegExp pris en charge)Rechercher des domaines par nom
aliasNonChaîne (RegExp pris en charge)Rechercher des domaines par nom d'alias
recipientNonChaî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:

Créer un domaine

POST /v1/domains

Paramètre de corpsObligatoireTaperLa description
domainOuiChaîne (FQDN ou IP)Nom de domaine complet ("FQDN") ou adresse IP
planNonChaîne (énumérable)Type de régime (doit être "free", "enhanced_protection", ou "team", par défaut à "free" ou le forfait payant actuel de l'utilisateur, le cas échéant)
catchallNonChaîne (adresses e-mail délimitées) ou booléenCréer un alias fourre-tout par défaut, par défaut à true (si true il utilisera l'adresse e-mail de l'utilisateur de l'API comme destinataire, et si false aucun fourre-tout ne sera créé). Si une chaîne est transmise, il s'agit d'une liste délimitée d'adresses e-mail à utiliser comme destinataires (séparées par un saut de ligne, un espace et/ou une virgule)
has_adult_content_protectionNonBooléenIndique s'il faut activer la protection du contenu pour adultes de Spam Scanner sur ce domaine
has_phishing_protectionNonBooléenIndique s'il faut activer la protection anti-hameçonnage Spam Scanner sur ce domaine
has_executable_protectionNonBooléenActiver ou non la protection de l'exécutable Spam Scanner sur ce domaine
has_virus_protectionNonBooléenIndique s'il faut activer la protection antivirus Spam Scanner sur ce domaine
has_recipient_verificationNonBooléenDomaine global par défaut pour s'il faut exiger que les destinataires d'alias cliquent sur un lien de vérification d'e-mail pour que les e-mails transitent

Exemple de demande:

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

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:

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:

Mettre à jour le domaine

PUT /v1/domains/example.com

Paramètre de corpsObligatoireTaperLa description
smtp_portNonChaîne ou nombrePort personnalisé à configurer pour le transfert SMTP (la valeur par défaut est "25")
has_adult_content_protectionNonBooléenIndique s'il faut activer la protection du contenu pour adultes de Spam Scanner sur ce domaine
has_phishing_protectionNonBooléenIndique s'il faut activer la protection anti-hameçonnage Spam Scanner sur ce domaine
has_executable_protectionNonBooléenActiver ou non la protection de l'exécutable Spam Scanner sur ce domaine
has_virus_protectionNonBooléenIndique s'il faut activer la protection antivirus Spam Scanner sur ce domaine
has_recipient_verificationNonBooléenDomaine global par défaut pour s'il faut exiger que les destinataires d'alias cliquent sur un lien de vérification d'e-mail pour que les e-mails transitent

Exemple de demande:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u 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 corpsObligatoireTaperLa description
emailOuiChaîne (e-mail)Adresse e-mail pour inviter à la liste des membres du domaine
groupOuiChaîne (énumérable)Groupe avec lequel 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

Supprimer l'invitation au domaine

DELETE /v1/domains/:domain_name/invites

Paramètre de corpsObligatoireTaperLa description
emailOuiChaî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 corpsObligatoireTaperLa description
groupOuiChaîne (énumérable)Groupe avec lequel 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épertorier les alias de domaine

GET /v1/domains/example.com/aliases

Paramètre de chaîne de requêteObligatoireTaperLa description
nameNonChaîne (RegExp pris en charge)Rechercher des alias dans un domaine par nom
recipientNonChaîne (RegExp pris en charge)Rechercher des alias dans un domaine par destinataire

Exemple de demande:

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

Créer un nouvel alias de domaine

POST /v1/domains/example.com/aliases

Paramètre de corpsObligatoireTaperLa description
nameOuiChaîneSurnom
recipientsOuiChaîne ou tableauListe 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)
descriptionNonChaîneDescription de l'alias
labelsNonChaîne ou tableauListe des étiquettes (doit être un saut de ligne / espace / chaîne ou tableau séparé par des virgules)
has_recipient_verificationNonBooléenS'il faut activer pour demander aux destinataires de cliquer sur un lien de vérification d'e-mail pour que les e-mails soient acheminés (par défaut, le paramètre du domaine s'il n'est pas explicitement défini dans le corps de la demande)
is_enabledNonBooléenIndique 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:

Récupérer l'alias de domaine

Vous pouvez récupérer un alias de domaine soit par son id ou son name évaluer.

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

Exemple de demande:

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

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

Exemple de demande:

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

Mettre à jour l'alias de domaine

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

Paramètre de corpsObligatoireTaperLa description
nameNonChaîneSurnom
recipientsOuiChaîne ou tableauListe 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)
descriptionNonChaîneDescription de l'alias
labelsNonChaîne ou tableauListe des étiquettes (doit être un saut de ligne / espace / chaîne ou tableau séparé par des virgules)
has_recipient_verificationNonBooléenS'il faut activer pour demander aux destinataires de cliquer sur un lien de vérification d'e-mail pour que les e-mails soient acheminés (par défaut, le paramètre du domaine s'il n'est pas explicitement défini dans le corps de la demande)
is_enabledNonBooléenIndique 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: