Documentation Namebay

/Documentation Namebay

Documentation Namebay

Bienvenue sur les documentations de Namebay.

Vous trouverez dans le menu ci-contre l’accès aux documentations techniques de l’API Namebay.

Namebay API :
Documentation technique concernant les différentes API Namebay :

  • API Noms de Domaines :
    Ensemble de commandes qui permet à nos revendeurs de s’interfacer avec le système de Namebay pour la gestion des noms de domaines, mais aussi pour accéder à des services complémentaires.
    Cet outil nécessite l’ouverture d’un compte revendeur NamebayAPI, l’accès est sécurisé par login et mot de passe.
  • API DNS :
    Cet ensemble de commandes de l’API est dédié à la gestion des zones DNS des revendeurs en utilisant l’infrastructure DNS Namebay.
    Il permet aux revendeurs de gérer les zones correspondant à leurs noms de domaine enregistrés.
    Notez que l’accès à cette fonction nécessite soit le service de gestion DNS avancée par domaine ou l’accès par revendeur à la gestion des zones par l’API.
    Veuillez contacter Namebay pour plus d’explications sur ces fonctions.
    NB: Les valeurs de chaque zone DNS sont automatiquement actualisées après chaque mise à jour de zone et / ou d’enregistrement.
  • API SSL :
    Ensemble de commandes permettant d’acheter et de gérer des Certificats SSL via l’API Namebay.
    Un compte revendeur Namebay est là aussi nécessaire.

Vue d’ensemble de l’API Namebay :

Chaque instruction xml (HTTP POST) est constituée:

  • de l’authentification de l’utilisateur Namebay (contactID et mot de passe à renseigner)
  • du nom de la commande (ou de l’action à effectuer) ;
  • des paramètres nécessaires au bon déroulement de l’opération ;
  • d’une réponse renvoyant le résultat de la requête effectuée chez Namebay et un (des) paramètre(s) en retour.

Pour chaque opération sollicitée, nous relèverons toujours la même chaîne d’identification de l’utilisateur. La  réponse Namebay à la commande est instantanée.

Attention : Pour toutes les commandes ci-contre, l’ordre des tags doit être respecté ainsi que leur casse.

Syntaxe de l’envoi d’une commande API et sa réponse :

Envoi de la commande :

<api>
 <authentication>
  <login>…</login>
  <password>…</password>
 </authentication>
 <command>
  <nom_de_la_commande>
   <nom_du_paramètre_entrant>…</nom_du_paramètre_entrant>
   […]
  </nom_de_la_commande>
 </command>
</api>

 

Réponse à la commande :

<?xml version= »1.0″ encoding= »utf-8″?>
<api>
 <response>
  <trID>…</trID>
  <result code= »… »>
   <msg>…</msg>
  </result>
 </response>
 <resData>
  <nom_de_la_commandeData>
   <nom_du_paramètre_sortant>…</nom_du_paramètre_sortant>
   […]
  </nom_de_la_commandeData>
 </resData>
</api>

Description détaillée des balises :

Envoi de la commande :

<api> : déclaration API.
 <authentication> :  déclaration de l’authentification de l’utilisateur API.
  <login>’votre login’</login> : login saisi par l’utilisateur.
  <password>’votre mot de passe’ </password> : mot de passe saisi par l’utilisateur.
 </authentication> : fin d’authentification .
 <command> : description de la commande.
  <nom_de_la_commande> : nom de la commande API.
   <nom_du_paramètre_entrant>’valeur du paramètre’</nom_du_paramètre_entrant> : Nom du paramètre entrant suivi de sa valeur, saisie par l’utilisateur. Il y a autant de balises que de paramètres.  Leur valeur est encapsulée entre la balise de début et celle de fin du nom du paramètre.
  </nom_de_la_commande> : fin de commande.
 </command> : fin de description de la commande .
</api> : fin de requête api.

 

Réponse à la commande :

<?xml version= »1.0″ encoding= »utf-8″?> : déclaration  XML.
<api> : déclaration API.
 <response> : déclaration de la réponse.
  <trID>‘numéro de la transaction’</trID> : numéro de la transaction api chez Namebay, lequel correspond à la commande passée.
  <result code= »’code de la réponse’« > : balise de résultat contenant le code retour en attribut. Cette balise encapsule celle contenant la valeur du message du code retour.
   <msg>’message’</msg> : message associé au code de retour
  </result> : fin de déclaration de la balise de résultat.
 </response> : fin de déclaration de la réponse.
 <resData> : déclaration des données en retour.
  <nom_de_la_commandeData> : nom de la commande API passée.
   <nom_du_paramètre_sortant>’valeur du paramètre’ </nom_du_paramètre_sortant> : Nom du paramètre sortant et sa valeur. Il y a autant de balises que de paramètres. Leur valeur est encapsulée entre la balise de début et celle de fin du nom du paramètre.
  </nom_de_la_commandeData> : fin de la commande.
 </resData> : fin de déclaration des valeurs retournées.
</api> : fin de réponse api.

Exemple d’envoi de  commande et sa réponse : commande « Contact_check »

Envoi de la commande :

<api>
 <authentication>
  <login>MonLogin</login>
  <password>MonMotDePasse</password>
 </authentication>
 <command>
  <contact_check>
   <contact_id>MonID</contact_id>
  </contact_check>
 </command>
</api>

 

Réponse à la commande :

<?xml version= »1.0″ encoding= »utf-8″?>
<api>
 <response>
  <trID>NBAY-API-508279318082006050401</trID>
  <result code= »200″>
   <msg>command completed successfully</msg>
  </result>
 </response>
 <resData>
  <contact_chkData>
   <contact_id available= »1″>MonID</contact_id>
  </contact_chkData>
 </resData>
</api>