Introduction

Ce document décrit l'API Freenom. Il explique les formats de données supportés et comment interagir avec l'API. Pour chaque fonction supportée par l'API, une description est donnée et inclut un exemple et à quoi la réponse ressemble.

Les exemples sont donnés en utilisant l'outil de commande "curl". Curl est un outil facile qui permet d'accéder a n'importe quel URL et est installé sur la plupart des environnements Unix.

 

Formats de données

L'API donne un résultat en format JSON par défaut. Si l'utilisateur préfère, la réponse peut être donnée en XML. La méthode de réponse est définie dans la fonction.

Example: Faire un "ping"

Input
Requète
Output
Réponse

Example: Faire un "ping" du service avec une réponse XML. Noter le .xml à la fin de la commande

Input
Requète
Output
Réponse

les exemples de ce manuel sont donnés en XML pour des questions de lisibilité.


 

Interagir avec l'API Freenom

L'interaction avec l'API est simple. Le service est RESTful et interagit par HTTPS. On utilisera surtout les méthodes GET et PUT. GET permet de recevoir des informations et GET envoie des informations.

Les actions POST sont idempotentes pendant 30 secondes. Cela veut dire que l'action n'est prise en compte qu'une fois même si elle est soumise plusieurs fois pendant ce lapse de 30 secondes.


 

Erreures courantes

Chaque fonction supportée par l'API a ete documentée. Certaines erreurs sont également décrites dans ce chapitre.

Fonction non trouvée

Si une certaine fonction n'est pas supportée, le service donnera la réponse suivante:

Non autorisé

La plupart des fonctions ne peuvent être exécutées que par des utilisateurs authentifiés. Pour ces fonctions, une autorisation doit avoir lieu. Si l'autorisation échoue, la réponse sera:

Données invalides

Si la fonction elle meme est supportée mais les données soumises sont invalides ou manquantes, l'erreur sera:

Input
Requète
Output
Réponse

Le champ statut indiquera "erreur" quand une erreur surviendra. Un élément affichera alors l'erreur en cause.

Le service répondra toujours directement quand une première erreur est trouvée. Si plusieurs erreurs sont trouvées, une seule sera reportée.


 

Function parameters

Paramètres fréquemment utilisés

Un certain nombre de paramètres sont utilisés dans plusieurs fonctions. D'autres paramètres sont décrits dans ce chapitre.

domainname

Le nom de domaine en question. Ce nom de domaine ne peut être composé que de lettres de a-z et de chiffres 0-9 et du tiret (-). Le tiret ne peut se trouver au début ou a la fin du nom de domaine. Les noms de domaines ne respectent pas la casse.

forward_url

Si le nom de domaine est configuré pour la redirection (Forwarding), l'URL de destination pour le domaine est entrée via le forward_url. Le forward_url ne peut être que une URL en HTTP ou HTTPS.

nameserver

Le nameserver. Un nameserver doit être un nom d'hôte qui peut être résolu si c'est un nom d'hôte qui n'est pas sous le domaine spécifié.

period

La période d'enregistrement ou renouvellement du domaine. Les domaines payants sont enregistrés pour un certain nombre d'années. Le nombre d'années possible est: 1Y, 2Y, 3Y, 4Y, 5Y, 9Y et 10Y. Les domaines gratuits sont enregistrés pour un certain nombre de mois. Les nombres de mois possibles sont de 1M à 12M.

idshield

ID Shield est un service d'anonymat GRATUIT qui sert à vous protéger. Vos informations personnelles ne sont pas publiées dans la base de données WHOIS, et les emails vous sont automatiquement envoyés, après un test de détection humaine (captcha), à l'adresse email de votre compte. Les deux valeurs possibles pour ce paramètre sont "enabled" ou "disabled".

 

Paramètres de support

Les paramètres de support sont les paramètres qui ne sont pas spécifiques a la fonction, mais au comportement de l'API.

test_mode

Lorsque cette valeur est égale à 1, cette fonction est effacée après son exécution. Tous les changements ayant été faits à la base de données Freenom sont annulés.

method

Si l'émetteur de la commande est incapable de spécifier la méthode de la fonction, ce paramètre peut aider à indiquer la méthode. En indiquant la méthode "post", on dit au service que la méthode POST était voulue. Même chose pour la méthode "get", "put" et "delete".

 

Les flags multiples

Les paramètres de fonction sont décrits dans un tableau pour chaque fonction. La colonne "multiple" indique si un paramètre peut être utilisé plusieurs fois ou non.

une commande API ressemble a cela:

 

Fonctions API

 

Faire un "ping"

Input
URL: https://api.freenom.com/v2/service/ping
Methode: GET
Input
Description: Cette fonction permet a l'utilisateur de vérifier le statut du serveur. Le serveur répondra avec le dernier timestamp.

Paramètres: Aucun.

Réponse
Propriété Description
result PING REPLY
timestamp YYYY-MM-DD HH24:MI:SS UTC
status OK

 

Example:

Input
Requète
Output
Réponse

 


Rechercher un nom de domaine disponible

Input
URL: https://api.freenom.com/v2/domain/search
Methode: GET
Input
Description: Cette fonction permet de rechercher la disponibilité d'un domaine.
Paramètres
Paramètre Description Requis Multiple
domainname Le nom du domaine Oui Non
email Adresse email utilisée pour vérification Non Non
password Mot de passe utilisé pour login Non Non
domaintype Le type du domaine : PAID ou FREE (payant ou gratuit) Oui Non

 

Réponse
Propriété Description Type
result DOMAIN AVAILABLE ou DOMAIN NOT AVAILABLE Les deux
domain un ou plusieurs termes avec le résultat de la recherche de nom de domaine Les deux
 domainname Le nom du domaine demandé Les deux
 domaintype Le type du domaine ayant été recherché Les deux
 pricing Termes relatifs aux prix du domaine. Payant
  currency La devise des prix indiqués Payant
  period La période d'enregistrement pour le prix indiqué Payant
  partnerprice Le montant devant etre payé par le registrar Payant
  retailprice Le montant devant etre payé par l'utilisateur final (prix publique) Payant
 status AVAILABLE ou NOT AVAILABLE Les deux
status OK Les deux

 

Example: Vérifier la disponibilité du domaine test001.tk

Input
Requète
Output
Réponse

Enreigstrer un domaine

Input
URL: https://api.freenom.com/v2/domain/register
Methode: POST
Input
Description: Utiliser cette fonction pour enregistrer un nouveau domaine.
Paramètres
Paramètre Description Requis Multiple
domainname Le nom du domaine Oui Non
period Durée d'enregistrement. Si cette valeur n'est pas renseignée, par defaul 1 an pour domaines payants et 3 mois pour domaines gratuits Non Non
forward_url L'URL vers laquelle le domaine doit rediriger Non* Non
forward_mode The type of forward. Can be cloak or 301_redirect. cloak is default. Non Non
nameserver Le nameserver à utiliser. Un minimum de 2 nameservers est requis Non* Oui
owner_id Contact ID du propriétaire du domaine Oui** Non
billing_id Contact ID du contact de facturation Non Non
tech_id Contact ID du contact technique Non Non
admin_id Contact ID du contact admin Non Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non
domaintype Le type du domaine : PAID ou FREE (payant ou gratuit) Oui Non
idshield Protection de l'identité. Valeur possible: "enabled" ou "disabled" (activé ou désactivé) Non** Non
autorenew Autorenewal setting for this domain. Possible values: enabled or disabled. Non Non


Notes: * forward_url et nameservers sont mutuellement exclusif. Seul l'un OU l'autre peut être indiqué. Il n'est pas possible d'avoir les deux. Si un nameserver est utilisé sous le domaine même, un glue record doit être utilisé pour ce domaine.

** si idshield est activé, owner_id n'a pas besoin d'être spécifié.

Réponse
Propriété Description Type
result DOMAIN REGISTERED ou NOT AVAILABLE Les deux
domain un ou plusieurs termes avec le résultat de l'enregistrement de nom de domaine Les deux
 currency La devise des prix indiqués Payant
 domainname Le nom du domaine demandé Les deux
 domaintype Le type du domaine ayant été vérifié Les deux
 expirationdate La date d'expiration du domaine au format AAAAMMJJ Les deux
 period La période d'enregistrement pour le domaine enregistré Les deux
 partnerprice Le montant devant etre payé par le registrar Payant
 retailprice Le montant devant etre payé par l'utilisateur final (prix publique) Payant
 owner_id Contact ID du propriétaire du domaine Payant
 tech_id Contact ID du contact technique Payant
 billing_id Contact ID du contact de facturation Payant
 admin_id Contact ID du contact admin Payant
 status REGISTERED ou NOT AVAILABLE Les deux
 authcode code d'autorisation généré Payant
 autorenew Autorenewal flag. Either enabled or disabled. Payant
status OK Les deux

 

Example: Enregistrer un domaine pour 2 ans avec des nameservers

Input
Requète
Output
Réponse

Renouveler un nom de domaine

Input
URL: https://api.freenom.com/v2/domain/renew
Methode: POST
Input
Description: Utiliser cette fonction pour renouveler un domaine.
Paramètres
Paramètre Description Requis Multiple
domainname Le nom du domaine Oui Non
period Durée d'enregistrement. Si cette valeur n'est pas renseignée, par defaul 1 an pour domaines payants et 3 mois pour domaines gratuits Non Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non
Réponse
Propriété Description Type
result DOMAIN RENEWED ou NOT AVAILABLE Payant
domain un ou plusieurs termes avec le résultat du renouvellement de nom de domaine Les deux
 currency La devise des prix indiqués Payant
 domainname Le nom du domaine demandé Les deux
 domaintype Le type du domaine ayant été vérifié Les deux
 expirationdate La date d'expiration du domaine au format AAAAMMJJ Les deux
 period La période d'enregistrement pour le domaine enregistré Les deux
 partnerprice Le montant devant etre payé par le registrar Payant
 retailprice Le montant devant etre payé par l'utilisateur final (prix publique) Payant
 owner_id Contact ID du propriétaire du domaine Payant
 tech_id Contact ID du contact technique Payant
 billing_id Contact ID du contact de facturation Payant
 admin_id Contact ID du contact admin Payant
 status RENEWED or NOT AVAILABLE Les deux
status OK Les deux

 

Example: Renouvellement du domaine payant TEST001.TK pour trois années.

Input
Requète
Output
Réponse

Obtenir des informations sur un domaine

Input
URL: https://api.freenom.com/v2/domain/getinfo
Methode: GET
Input
Description: Recevoir les informations a propos d'un domaine enregistré par l'utilisateur.
Paramètres
Paramètre Description Requis Multiple
domainname Le nom du domaine Oui Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non
Réponse
Propriété Description Type
result DOMAIN LISTED Les deux
domain un ou plusieurs termes avec le résultat de la recherche de nom de domaine Les deux
 domainname Le nom du domaine demandé Les deux
 domaintype Le type du domaine ayant été vérifié Les deux
 expirationdate La date d'expiration du domaine au format AAAAMMJJ Les deux
 authcode Le code d'autorisation Payant
 autorenew Autorenewal flag. Either enabled or disabled. Payant
 pricing Termes relatifs aux prix du domaine. Payant
  currency La devise des prix indiqués Payant
  period La période d'enregistrement pour le domaine vérifié Payant
  partnerprice Le montant devant etre payé par le registrar Payant
  retailprice Le montant devant etre payé par l'utilisateur final (prix publique) Payant
 status ACTIVE or CANCELLED; Statut du domaine Les deux
 forward_url L'URL vers laquelle le domaine doit rediriger Les deux
 forward_mode The type of forward. Can be cloak or 301_redirect. cloak is default. Les deux
 nameserver information sur un ou plusieurs namerservers Les deux
  hostname Hostname du nameserver Les deux
  ipaddress Adresse IP du nameserver si un glue est présent Les deux
 owner_contact Le terme contenant les informations du propriétaire Payant
  contact_id Contact ID du contact propriétaire Payant
  contact_title Titre du contact: M, Mme, etc Payant
  contact_firstname Prénom du contact Payant
  contact_middlename Deuxième prénom du contact propriétaire Payant
  contact_lastname Nom de famille du contact propriétaire Payant
  contact_organization Nom de société du contact propriétaire (optionnel) Payant
  contact_address Adresse du contact propriétaire Payant
  contact_city Ville du contact propriétaire Payant
  contact_zipcode Code postal du contact propriétaire Payant
  contact_statecode Code de la province ou département (ISO 3166-2) du contact propriétaire Payant
  contact_countrycode Code pays (ISO 3166-1) du contact propriétaire Payant
  contact_phone Numéro de téléphone du contact propriétaire Payant
  contact_fax Numéro de fax du contact propriétaire Payant
  contact_email Adresse email du contact propriétaire Payant
 admin_contact Hash contenant les informations pour contacter l'admin Payant
  contact_id Contact ID du contact admin Payant
  contact_title Titre du contact: M, Mme, etc Payant
  contact_firstname Prénom du contact admin Payant
  contact_middlename Deuxième prénom du contact admin Payant
  contact_lastname Nom de famille du contact admin Payant
  contact_organization nom de société du contact admin (optionnel) Payant
  contact_address Adresse du contact admin Payant
  contact_city Ville du contact admin Payant
  contact_zipcode Code postal du contact admin Payant
  contact_statecode Code de la province ou département (ISO 3166-2) du contact admin Payant
  contact_countrycode Code pays (ISO 3166-1) du contact admin Payant
  contact_phone Numéro de téléphone du contact admin Payant
  contact_fax Numéro de fax du contact admin Payant
  contact_email Adresse email du contact admin Payant
 tech_contact Contact ID du contact technique Payant
  contact_id Contact ID du contact technique Payant
  contact_title Titre du contact: M, Mme, etc Payant
  contact_firstname Prénom du contact technique Payant
  contact_middlename Deuxième prénom du contact technique Payant
  contact_lastname Nom de famille du contact technique Payant
  contact_organization Nom de société du contact technique (optionnel) Payant
  contact_address Adresse du contact technique Payant
  contact_city Ville du contact technique Payant
  contact_zipcode Code postal du contact technique Payant
  contact_statecode Code de la province ou département (ISO 3166-2) du contact technique Payant
  contact_countrycode Code pays (ISO 3166-1) du contact technique Payant
  contact_phone Numéro de téléphone du contact technique Payant
  contact_fax Numéro de fax du contact technique Payant
  contact_email Adresse email du contact technique Payant
 billing_contact Hash contenant les coordonnées du contact de facturation Payant
  contact_id Contact ID du contact de facturation Payant
  contact_title Titre du contact : M, Mme, etc Payant
  contact_firstname Prénom du contact de facturation Payant
  contact_middlename Deuxième prénom du contact de facturation Payant
  contact_lastname Nom de famille du contact de facturation Payant
  contact_organization Nom de société du contact de facturation (optionnel) Payant
  contact_address Adresse du contact de facturation Payant
  contact_city Ville du contact de facturation Payant
  contact_zipcode Code postal du contact de facturation Payant
  contact_statecode Code de province (ISO 3166-2) du contact de facturation Payant
  contact_countrycode Code pays (ISO 3166-1) du contact de facturation Payant
  contact_phone Numéro de téléphone du contact de facturation Payant
  contact_fax Numero de fax du contact de facturation Payant
  contact_email Adresse email du contact de facturation Payant
status OK Les deux

 

Example: Obtenir les informations du domaine TEST002.TK

Input
Requète
Output
Réponse

Modifier un domaine

Input
URL: https://api.freenom.com/v2/domain/modify
Methode: PUT
Input
Description: Cette fonction permet de mettre a jour les parametres DNS ou URL Forward d'un domaine.
Paramètres
Paramètre Description Requis Multiple
domainname Le nom du domaine Oui Non
forward_url L'URL vers laquelle le domaine doit rediriger Non* Non
forward_mode The type of forward. Can be cloak or 301_redirect. cloak is default. Non Non
nameserver Le nameserver à utiliser. Un minimum de 2 est requis Non* Oui
owner_id Contact ID du propriétaire du domaine Non Non
admin_id Contact ID du contact admin Non Non
tech_id Contact ID du contact technique Non Non
billing_id Contact ID du contact de facturation Non Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non
idshield Protection de l'identité. Valeur possible: "enabled" ou "disabled" (activé ou désactivé) Non Non
autorenew Autorenewal setting for this domain. Possible values: enabled or disabled. Non Non

 

Notes: * forward_url et nameservers sont mutuellement exclusif. Seul l'un OU l'autre peut être indiqué. Il n'est pas possible d'avoir les deux. Si un nameserver est utilisé sous le domaine même, un glue record doit être utilisé pour ce domaine.

 

Réponse
Propriété Description Type
domain un ou plusieurs termes avec le résultat de la modification de nom de domaine Tous
 domainname Le nom du domaine demandé Tous
 status MODIFIED Tous
result DOMAIN MODIFIED Tous
status OK Tous

 

Example: Modifier le domaine TEST002.TK, et le rediriger vers http://www.freenom.com/

Input
Requète
Output
Réponse

Effacer un domaine

Input
URL: https://api.freenom.com/v2/domain/delete
Methode: DELETE
Input
Description: Cette commande effacera le domaine du compte. Le domaine sera immédiatement disponible a l'enregistrement par d'autres utilisateurs.
Paramètres
Paramètre Description Requis Multiple
domainname Le nom du domaine Oui Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non

 

Réponse
Propriété Description Type
domain un ou plusieurs termes avec le résultat de la suppression de nom de domaine Tous
 domainname Nom de domaine effacé Tous
 status DELETED Tous
 result DOMAIN DELETED Tous
status OK Tous

 

Example: Effacer TEST002.TK

Input
Requète
Output
Réponse

Restaurer un domaine

Input
URL: https://api.freenom.com/v2/domain/restore
Methode: POST
Input
Description: Cette commande pourra restaurer un domaine sur le compte, si cela est autorisé.
Paramètres
Paramètre Description Requis Multiple
domainname Le nom du domaine Oui Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non

 

Réponse
Propriété Description Type
domain un ou plusieurs termes avec le résultat de la restauration de nom de domaine Tous
 domainname Nom de domaine restauré Tous
 result DOMAIN RESTORED Tous
 status RESTORED Tous
status OK Tous

 

Example:

Input
Requète
Output
Réponse

Surclasser un domaine

Input
URL: https://api.freenom.com/v2/domain/upgrade
Methode: POST
Input
Description: Surclasser un domaine gratuit en domaine payant
Paramètres
Paramètre Description Requis Multiple
domainname Le nom du domaine Oui Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non
owner_id Contact ID du contact propriétaire Non** Non
billing_id Contact ID du contact de facturation Non Non
admin_id Contact ID du contact admin Non Non
tech_id Contact ID du contact technique Non Non
idshield Protection de l'identité. Valeur possible: "enabled" ou "disabled" (activé ou désactivé) Non** Non
period Nombre d'années à ajouter à la date d'expiration du domaine, après le surclassement du domaine. Oui Oui

Notes: ** si idshield est activé, owner_id n'a pas besoin d'être spécifié.

Réponse
Propriété Description Type
domain un ou plusieurs termes avec le résultat du surclassement de nom de domaine Tous
 domainname Nom de domaine surclassé Tous
 result DOMAIN UPGRADED Tous
 status UPGRADED Tous
status OK Tous

 

Example: Surclasser un domaine gratuit en domaine payant

Input
Requète
Output
Réponse

Obtenir la liste des domaines du compte

Input
URL: https://api.freenom.com/v2/domain/list
Methode: GET
Input
Description: Obtenir la liste des domaines du compte
Paramètres
Paramètre Description Requis Multiple
pagenr Numéro de la page des resultats. Défaut 1 Non Non
results_per_page Nombre de résultats par page. Défaut 25 Non Non
email Adresse email utilisée pour vérification Non Non
password Mot de passe utilisé pour login Non Non

 

Réponse
Propriété Description Type
domain un ou plusieurs termes avec le résultat de la suppression de nom de domaine Les deux
 domainname Le nom du domaine Les deux
 domaintype Le type du domaine Les deux
 registrationdate La date d'enregistrement du domaine au format AAAAMMJJ Les deux
 expirationdate La date d'expiration du domaine au format AAAAMMJJ Les deux
 status ACTIVE or CANCELLED; Statut du domaine Les deux
 authcode Le code d'autorisation Payant
 autorenew Autorenewal flag. Either enabled or disabled. Payant
result DOMAINS FOUND Les deux

 

Example:

Input
Requète
Output
Réponse

Enregistrer ou modifier un nameserver "glue"

Input
URL: https://api.freenom.com/v2/nameserver/register
Methode: PUT
Input
Description: Lorsque le DNS d'un domaine renvoie vers des nameserveurs personnalisés et que les namerservers sont un sous-domaine du domaine, des nameserver glue record sont requis pour que le domaine fonctionne. Les nameserver glue records peuvent être enregistrés en utilisant cette fonction
Paramètres
Paramètre Description Requis Multiple
domainname Le nom de domaine du glue record Oui Non
hostname Le nom de domaine du glue record Oui Non
ipaddress Valeur du DNS record Oui Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non

 

Réponse
Propriété Description Type
result NAMESERVER REGISTERED ou NAMESERVER UPDATED Tous
nameserver un ou plusieurs termes avec le résultat de l'enregistrement du nameserver Tous
 domainname Le nom de domaine Tous
 hostname Hostname du glue record Tous
 ipaddress L'adresse IP du glue record Tous
 status REGISTERED or UPDATED Tous
status OK Tous

 

Example: Enregistrer un nameserver "glue" pour TEST002.TK

Input
Requète
Output
Réponse

Effacer un nameserver "glue"

Input
URL: https://api.freenom.com/v2/nameserver/delete
Methode: DELETE
Input
Description: Les nameserver glue records peuvent être effacés via cette commande.
Paramètres
Paramètre Description Requis Multiple
domainname Le nom de domaine du glue record Oui Non
hostname Le hostname devant etre effacé Oui Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non

 

Réponse
Propriété Description Type
result NAMESERVER DELETED Tous
nameserver un ou plusieurs termes avec le résultat de la suppression du nameserver Tous
 domainname Nom de domaine de la zone Tous
 hostname Le nameserver devant etre effacé Tous
 status DELETED Tous
status OK Tous

 

Example: Enregistrer un nameserver "glue" pour TEST002.TK

Input
Requète
Output
Réponse

Obtenir la liste des nameservers "glue" d'un domaine

Input
URL: https://api.freenom.com/v2/nameserver/list
Methode: GET
Input
Description: Cette commande permet de recevoir une liste des namerserver glue records enregistrés sous un domaine.
Paramètres
Paramètre Description Requis Multiple
domainname Le domaine pour lequel on veut afficher les glue nameserver Oui Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non

 

Réponse
Propriété Description Type
result ENTRIES - nombre de résultats trouvés Tous
nameserver Nom du DNS record Tous
 domainname Le nom du domaine demandé Tous
 hostname Valeur du DNS record Tous
 ipaddress L'adresse IP du nameserver host Tous
status OK Tous

 

Example: Obtenir les nameservers pour TEST002.TK

Input
Requète
Output
Réponse

 

Fonctions relatives à la gestion des contacts

 

Créer ou Modifier un contact

Input
URL: https://api.freenom.com/v2/contact/register
Methode: PUT
Input
Description: Cette commande permet d'enregistrer un nouveau contact. Le contact n'est pas lié a un domaine particulier. Il doit être lié a un domaine particulier lors de l'enregistrement ou la modification de ce domaine.
Paramètres
Paramètre Description Requis Multiple
contact_organization Nom de société du contact (optionnel) Non Non
contact_title Titre du contact Non Non
contact_firstname Prénom du contact Oui Non
contact_middlename Deuxième prénom du contact Non Non
contact_lastname Nom de famille du contact Oui Non
contact_address Adresse du contact Oui Non
contact_city Ville du contact Oui Non
contact_zipcode Code postal du contact Oui Non
contact_statecode Code ISO-3166 de province Oui Non
contact_countrycode Code ISO-3166 du pays Oui Non
contact_phone Numéro de téléphone du contact (format international) Oui Non
contact_fax Numéro de fax du contact (format international) Non Non
contact_email Adresse email du contact Oui Non
contact_id ID du contact existant Non Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non

 

Réponse
Propriété Description Type
result CONTACT REGISTERED / CONTACT UPDATED Payant
contact un ou plusieurs termes avec les contacts affectés Payant
 contact_id ID du contact enregistré ou mis à jour Payant
 status REGISTERED / UPDATED Payant
status OK Payant

 

Example: Enregistrer un Contact

Input
Requète
Output
Réponse

 


Effacer un contact

Input
URL: https://api.freenom.com/v2/contact/delete
Methode: DELETE
Input
Description: La suppression d'un contact peut être faite grâce a cette commande. Un contact ne peut etre effacé que si il n'est associé a aucun domaine.
Paramètres
Paramètre Description Requis Multiple
contact_id ID du contact Oui Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non

 

Réponse
Propriété Description Type
result CONTACT DELETED Payant
contact un ou plusieurs termes avec les contacts affectés Payant
 contact_id ID du contact effacé Payant
 status DELETED Payant
status OK Payant

 

Example: Effacer un Contact

Input
Requète
Output
Réponse

 


Obtenir des informations sur un contact specifique

Input
URL: https://api.freenom.com/v2/contact/getinfo
Methode: GET
Input
Description: Affiche les information des contacts du compte.
Paramètres
Paramètre Description Requis Multiple
contact_id un ou plusieurs contact ID sur lesquels on veut obtenir des informations Oui Oui
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non

 

Réponse
Propriété Description Type
result CONTACTS LISTED Payant
contact un ou plusieurs termes relatifs aux contacts Payant
 contact_id ID du contact Payant
 contact_title Titre du contact Payant
 contact_firstname Prénom du contact Payant
 contact_middlename Deuxième prénom du contact Payant
 contact_lastname Nom de famille du contact Payant
 contact_organization Nom de société du contact (optionnel) Payant
 contact_address Adresse du contact Payant
 contact_city Ville du contact Payant
 contact_zipcode Code postal du contact Payant
 contact_statecode Pays du contact Payant
 contact_countrycode Province du contact Payant
 contact_phone Numéro de téléphone du contact (format international) Payant
 contact_fax Numéro de fax du contact (format international) Payant
 contact_email Adresse email du contact Payant
 contact_domain Paramètres d'un ou plusieurs contacts Payant
  domainname Nom du domaine lié au contact Payant
  type Type de Contact (propriétaire, tech, admin ou facturation) Payant
status OK Payant

 

Example: Obtenir les informations pour un contact_id

Input
Requète
Output
Réponse

 


Obtenir la liste des contacts d'un compte

Input
URL: https://api.freenom.com/v2/contact/list
Methode: GET
Input
Description: Affiche la liste de tous les contacts du compte.
Paramètres
Paramètre Description Requis Multiple
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non

 

Réponse
Propriété Description Type
result CONTACTS LISTED Payant
contact un ou plusieurs termes relatifs aux contacts Payant
 contact_id ID du contact Payant
 contact_title Titre du contact Payant
 contact_firstname Prénom du contact Payant
 contact_middlename Deuxième prénom du contact Payant
 contact_lastname Nom de famille du contact Payant
 contact_organization Nom de société du contact (optionnel) Payant
 contact_address Adresse du contact Payant
 contact_city Ville du contact Payant
 contact_zipcode Code postal du contact Payant
 contact_statecode Pays du contact Payant
 contact_countrycode Province du contact Payant
 contact_phone Numéro de téléphone du contact (format international) Payant
 contact_fax Numéro de fax du contact (format international) Payant
 contact_email Adresse email du contact Payant
 contact_domain Paramètres d'un ou plusieurs contacts Payant
  domainname Nom du domaine lié au contact Payant
  type Type de Contact (propriétaire, tech, admin ou facturation) Payant
status OK Payant

 

Example: Liste des Contacts

Input
Requète
Output
Réponse

 

Fonctions relatives au transfer des domaines

 

Obtenir le prix d'un transfert de domaine

Input
URL: https://api.freenom.com/v2/domain/transfer/price
Methode: GET
Input
Description: Les transferts sont demandés par le compte qui "gagne" le domaine, en utilisant le code d'autorisation fourni par le compte qui "perd" le domaine. Tous les transferts entrainent automatiquement un renouvellement d'un an. Avant qu'un transfert soit fait, l'utilisateur "gagnant" le domaine peut verifier le prix du renouvellement du domaine. Cette commande donne le prix du renouvellement et n'exécute pas le transfert.
Paramètres
Paramètre Description Requis Multiple
domainname The domainname Oui Non
authcode Le code d'autorisation Oui Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non

 

Réponse
Propriété Description Type
transfer Propriétés de un ou plusieurs transferts Payant
 domainname Nom de domaine mis à jour Payant
 domaintype Le type du domaine Payant
 period Duréé de renouvellement lors du transfert. Toujours 1 an. Payant
 currency La devise des prix indiqués Payant
 retailprice Prix pour titulaire Payant
 partnerprice Prix pour le registrar ou partenaire Payant
result PRICES PROVIDED Payant
status OK Payant

 

Example: Demander le prix de transfert pour TEST002.TK

Input
Requète
Output
Réponse

 


Demander un transfert de domaine

Input
URL: https://api.freenom.com/v2/domain/transfer/request
Methode: POST
Input
Description: Les demandes de transfert sont faites par des utilisateurs qui souhaitent transferer leur domaines depuis un autre utilisateur vers leur compte.
Please note: A domain transfer for a .TK, .ML, .CF, .GA or .GQ domain will be directly approved if the request has the correct authorization code.

Paramètres
Paramètre Description Requis Multiple
domainname Le nom du domaine Oui Non
authcode Le code d'autorisation Oui Non
period Nombre d'années ajoutées lors du renouvellement. Toujours 1 an. Oui Non
owner_id Contact ID du nouveau propriétaire Oui Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non

 

Réponse
Propriété Description Type
result TRANSFER REQUESTED Payant
transfer Propriétés de un ou plusieurs transferts Payant
 domainname Nom de domaine mis à jour Payant
 status REQUESTED Payant
status OK Payant

 

Example: Transferer TEST002.TK vers notre compte

Input
Requète
Output
Réponse

 


Approuver un transfert de domaine

Input
URL: https://api.freenom.com/v2/domain/transfer/approve
Methode: POST
Input
Description: Approuve un transfert sortant.
Paramètres
Paramètre Description Requis Multiple
domainname The domainname Oui Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non

 

Réponse
Propriété Description Type
result TRANSFER APPROVED Payant
transfer Propriétés de un ou plusieurs transferts Payant
 domainname Nom de domaine mis à jour Payant
 status APPROVED Payant
status OK Payant

 

Example: Approuver le transfert du domaine TEST002.TK hors de notre compte

Input
Requète
Output
Réponse

 


Refuser un transfert de domaine

Input
URL: https://api.freenom.com/v2/domain/transfer/decline
Methode: POST
Input
Description: Refuse un transfert sortant.
Paramètres
Paramètre Description Requis Multiple
domainname Le nom de domaine Oui Non
reason Raison de l'échec du transfert Oui Non
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non

 

Réponse
Propriété Description Type
result TRANSFER DECLINED Payant
transfer Propriétés de un ou plusieurs transferts Payant
 domainname Nom de domaine mis à jour Payant
 status DECLINED Payant
status OK Payant

 

Example: Refuser le transfert du domaine TEST002.TK hors de notre compte

Input
Requète
Output
Réponse

 


Obtenir la liste des transferts

Input
URL: https://api.freenom.com/v2/domain/transfer/list
Methode: GET
Input
Description: Recevoir une liste des transferts de domaines en cours. Les transferts de domaines qui sont en statut "approuvé" ou "refusé" seront visible une semaine après la mise a jour du transfert.
Paramètres
Paramètre Description Requis Multiple
email Adresse email utilisée pour vérification Oui Non
password Mot de passe utilisé pour login Oui Non

 

Réponse
Propriété Description Type
result TRANSFERS LISTED Payant
transfer Zero, une ou plusieurs entrées contenant les informations sur le transfert de domaine Payant
 domainname Le nom du domaine Payant
 transfertype Entrant ou Sortant Payant
 status Statut du transfert. PENDING, APPROVED, DECLINED Payant
 newregistrar Pour un transfer sortant, le nom du nouveau registrar Payant
 lastupdate Date de la dernière mise à jour Payant

 

Example: Obtenir une liste des transferts

Input
Requète
Output
Réponse