PRÉSENTATION NAMEBAY API
Téléchargez la fiche récapitulative 
Présentation
L'API (Application Program Interface) est un logiciel qui permet à nos revendeurs de s'interfacer avec le système de gestion de noms de domaine Namebay. Il leur offre la possibilité de passer de multiples commandes telles que la création, le renouvellement ou le transfert d'un nom de domaine, la création d'un contact, d'un serveur de noms, la modification de ces derniers, etc.
Cet outil nécessite l'ouverture d'un compte revendeur NamebayAPI, l'accès est sécurisé par login et mot de passe. Il est accessible via accès http, https ou TCPIP.
A qui s'adresse NAMEBAY API ?
|
L'API NAMEBAY s'adresse :
- aux professionnels de l'Internet,
- aux hébergeurs,
- aux cabinets juridiques,
- aux web-agencies,
- aux SSII,
- aux sociétés de référencement,
- aux tierces publication de contenu,
- ...
Elle peut être :
- intégrée à une plateforme d'hébergement,
- intégrée à un portail de services,
- intégrée à une solution d'ERP, de CRM, ...
|
 |
Elle permet aussi d'implémenter facilement un whois élargi à toutes les extensions sur toutes les solutions citées ci-dessus.
Généralités sur les commandes API
L'envoi des commandes se fait de façon électronique via une chaîne de caractères obéissant à des règles. Les informations saisies ou sélectionnées par l'utilisateur sont encapsulées dans des balises XML et envoyées sous forme de paramètres au système Namebay.
Concrètement, chaque instruction 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 renvoyantle 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.
Syntaxe et description des chaînes XML
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 lacommande'>
</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 commande’>
<’nom du paramètre sortant’>…</’nom du paramètre sortant’>
[…]
</’nom de la commande’>
</resData>
</api>
Exemple de 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> |
--> début de requête API
--> authentification de l'utilisateur API
--> identifiant de l'utilisateur
--> Mot de passe de l'utilisateur
--> fin de l'authentification
--> début de la description
--> nom de la commande
--> nom et valeur du paramètre entrant
--> fin de la commande
--> fin de la description
--> fin de requête API |
Réponse à la commande
<?xml version="1.0" encoding="utf-8"?>
<api>
<response>
<trID>NBAY-API-08279...</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> |
--> déclaration XML
--> début de requête API
--> début de la réponse
--> numéro de la transaction API
--> début de la description du résultat
--> message de la réponse
--> fin du résultat
--> fin de la réponse
--> données renvoyées
--> nom de la commande
--> paramètre sortant
--> fin d'envoi des paramètres sortants
--> fin du renvoi des données
--> fin de requête API
|
| Liste des commandes disponibles via NAMEBAY API |
| |
Account balance
Contact_check
Contact_create
Contact_delete
Contact_info |
Contact_update
Domain_check
Domain_create
Domain_info
Domain_renew |
Domain_transfer
Domain_transfer_query
Domain_transfer_update
Domain_update
Domain_whois |
Ns_check
Ns_create
Ns_delete
Ns_info
Ns_update |
