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.
Nous avons créé une API pour l'accès programmatique aux domaines, alias et plus encore.
Documentation API
Accès programmatique à vos donnéesAPI de transfert d'e-mails
Table des matières
- Bibliothèques
- URI de base
- Authentification
- les erreurs
- Localisation
- Pagination
- Compte
- Domaines
- Invite
- Membres
- Alias
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 |
.RAPPORTER | 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
est obsolète à compter du 1er janvier 2021.
Authentification
Tous les points finaux nécessitent votreclé API gratuite : tada: à définir comme valeur "username" 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
Si des erreurs se produisent, le corps de la réponse de la requête API contiendra un message d'erreur détaillé.
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 |
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 | Taper | 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"
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 corps | Obligatoire | Taper | 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"
Domaines
/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 | Taper | 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:
Créer un domaine
POST /v1/domains
Paramètre de corps | Obligatoire | Taper | 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 | Chaîne (adresses e-mail délimitées) ou booléen | Créez un alias fourre-tout par défaut, par défauttrue (sitrue il utilisera l'adresse e-mail de l'utilisateur de l'API en tant que destinataire, et sifalse 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) |
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 corps | Obligatoire | Taper | 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:
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 | Taper | 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
Supprimer l'invitation au domaine
DELETE /v1/domains/:domain_name/invites
Paramètre de corps | Obligatoire | Taper | 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 | Taper | 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
Paramètre de chaîne de requête | Obligatoire | Taper | La description |
---|---|---|---|
name |
Non | Chaîne (RegExp pris en charge) | Rechercher des alias dans un domaine par nom |
recipient |
Non | Chaî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 corps | Obligatoire | Taper | 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:
Mettre à jour l'alias de domaine
PUT /v1/domains/example.com/aliases/:alias_id
Paramètre de corps | Obligatoire | Taper | 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: