NAMEBAY API Toutes les commandes pour les revendeurs de noms de domaine en API V7.12 Documentation technique

Transcription

1 NAMEBAY API Toutes les commandes pour les revendeurs de noms de domaine en API V7.12 Documentation technique

2 V7.12 SOMMAIRE PRÉSENTATION... 3 COMMANDES Vue d ensemble Syntaxe et description des chaînes XML des commandes Syntaxe de l envoi d une commande API et sa réponse Description détaillée des balises Exemple d envoi de commande et sa réponse : commande «Contact_check» Liste des commandes (HTTP Post) Account balance Search Op info Reseller_transfert Contact_check Contact_create Contact_delete Contact_info Contact_update Domain_check Domain_check_multi Domain_create Domain_info Domain_protect Domain_renew Domain_transfer Domain_transfer_query Domain_transfer_update Domain_update Domain_whois Domain_authcode Domain_restore_request Domain_isrestorable Domain_istransferable Domain_trade Ns_check Ns_create Ns_delete Ns_info Ns_update Liste des commandes (SOAP) ohelloworld oislocal ogetautorenew osetautorenew ResellerTransfer NamebayWatchApiResearch Récapitulatif Code Erreur Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 2

3 1. PRÉSENTATION V7.12 L API Namebay est un 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. Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 3

4 2. COMMANDES 2.1. Vue d ensemble Il existe deux types de commandes : Commandes xml en HTTP POST sur Commandes SOAP (WebServices) Chaque instruction xml 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 Syntaxe et description des chaînes XML des commandes 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 lacommande </command> 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 > Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 4

5 < nom du paramètre sortant > </ nom du paramètre sortant > [ ] </ nom de la commande > </resdata> Code source d une page html qui post vers notre API: (UTF8 and text/xml) <html> <head> <title>api POST</title> </head> <body> <form action=" method="post" enctype="text/xml" acceptcharset="utf-8"> <textarea name="request" rows="10" cols="50" /> <input type="submit" name="b" value="executer"> </form> </body> </html> Les commandes post doivent être envoyées en utilisant le paramètre «request» Envoi de la commande Description détaillée des balises <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. : fin de requête api. Réponse du système NAMEBAY <?xml version="1.0" encoding="utf-8"?> : déclaration XML. <api> : déclaration API. <response> : déclaration de la réponse. Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 5

6 <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 "><msg> message </msg> </result>: balise de résultat contenant le code retour en attribut. Cette balise encapsule celle contenant la valeur du message du code retour. </response> : fin de déclaration de la réponse. <resdata> : déclaration des données en retour. < nom de la commande > : 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 commande > : fin de la commande. </resdata> : fin de déclaration des valeurs retournées Envoi de la commande Exemple d envoi de commande et sa réponse : commande «Contact_check» <api>  <authentication>  <login>monlogin</login>  <password>monmotdepasse</password>  </authentication>  <command>  <contact_check>  <contact_id>monid</contact_id>  </contact_check>  </command>   Réponse <?xml version="1.0" encoding="utf-8"?>  <api>  <response>  <trid>nbay-api </trid>  <result code="200">  <msg>command completed successfully</msg>  </result>  </response>  <resdata>  <contact_chkdata>  <contact_id available="1">monid</contact_id>  </contact_chkdata>  </resdata>   Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 6

7 2.3. Liste des commandes (HTTP Post) V Account balance Indique le montant actuel du compte de l utilisateur. Paramètres entrants Description Type Obligatoire API login Identifiant de l utilisateur String (min 3, max 10) API password Mot de passe de l utilisateur String (min 5, max 15) Paramètres sortants Description account_balance Solde du compte Commande [ ] <command> <account_balance /> </command> Réponse <?xml version="1.0" encoding="utf-8"?> <api> <response> <trid> </trid> <result code=" "> <msg> </msg> </result> </response> <resdata> <account_balance> </account_balance> </resdata> Search Entrée Description Type Obligatoire class list = 'contact' ou 'domain' Yes startrecord maxrecords numéro de l'enregistrement par lequel commencer nombre max d'enregistrement à extraire (max : 100) int Int No No Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 7

8 value Entrée Description Type Obligatoire chaine de caracteres avec comme type possible : - Domain : o domain o statut o admin o tech o billing o ns o expdate - Contact o contact_id o lastname o firstname o orgname o No Commande [ ] < search> <class>domain</class> <startrecord>0</startrecord> <maxrecords>20</maxrecords> <value type="admin">contactid</value> <value type="ns">dns1.namebay.com</value> <value type="expdate" op="lt"> </value> </search> </command> Réponse <?xml version="1.0" encoding="utf-8"?> <api> <response> <trid> </trid> <result code=" "> <msg> </msg> </result> </response> <results> <domain> <domainname>mondomaine.com</domainname> <status>active</status> Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 8

9 <credate> </credate> <expdate> </expdate> </domain> <domain> <domainname>mondomaine.net</domainname> <status>active</status> <credate> </credate> <expdate> </expdate> </domain> </results> </resdata> Op info Permet d avoir des informations sur une opération ainsi que la facture au format html. Paramètres entrants Description Type Obligatoire trid Numéro de transaction String API password Mot de passe de l utilisateur String Paramètres sortants Description type de valeur Obligatoire trid Numéro de transaction String regdate Date de l'opération Date amount Montant de l'opération vdouble tva Paiement de la TVA? Booleen payment_mode mode de paiement Chaîne de caractères invoice_id numéro de la facture entier invoice facture de l'opération Chaîne de caractères Commande [ ] <command> <op_info> <trid>n-w-jihdkjhdkhl54578</trid> </op_info> </command> Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 9

10 Réponse <api> <response> <trid>api-nupvv </trid> <result code="200"> <msg>command completed successfully</msg> </result> </response> <resdata> <op_infdata> <trid>n-w-jihdkjhdkhl54578</trid> <regdate> </regdate> <amount>14.35</amount> <tva>true</tva> <payment_mode>carte Bancaire</payment_mode> <invoice_id>000001</invoice_id> <invoice> <HTML><TITLE>Facture N </TITLE><BODY>SAM Namebay 27, Bd des Moulins 98000 MONACO Capital social : euros <center>FACTURE N </center> Le lundi 01 août 2000 TEST TEST CP VILLE PAYS Contact- Handle : IDTEST1 <TABLE BORDER="0" ALIGN="center"><TR BGCOLOR="#002A7E"><TD ALIGN="center">Description</TD><TD ALIGN="center">Periode (an)</td><td ALIGN="center">PU HT</TD><TD ALIGN="center">Total HT</TD></TR><TR><TD>Demande de transfert de noms de domaine </TD><TD ALIGN="center">1</TD><TD ALIGN="center">12</TD><TD ALIGN="center">12.00 Euros</TD></TR><TR><TD COLSPAN="5">domain.com</TD></TR><TR><TD COLSPAN="4" ALIGN="center"><HR></TD></TR><TR><TD COLSPAN="2" ALIGN="center"> </TD><TD>Total HT : </TD><TD>12.00 Euros</TD></TR><TR><TD COLSPAN="2" ALIGN="center"> </TD><TD>Total TVA : </TD><TD>2.35 Euros</TD></TR><TR><TD COLSPAN="2" ALIGN="center"> </TD><TD>Total TTC : </TD><TD>14.35 Euros</TD></TR><TR><TD COLSPAN="4"> </TD></TR><TR><TD COLSPAN="4" ALIGN="center">Siret : 741 G APE : 741 G - Numéro de TVA Intracommunautaire : FR </TD></TR></TABLE><BODY></HTML> </invoice> </op_infdata> </resdata> Reseller_transfert Cette commande permet de transférer un domaine d un revendeur Namebay à un autre. L authentification est gérée à l aide de l AuthenticationHeader du Web Service, vos identifiants restent inchangés. name Entrée Description Type Obligatoire _registrant Nom du domaine à transférer La nouvelle adresse du registrant. string string Yes Yes Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 10

11 send V7.12 Entrée Description Type Obligatoire newresellercontact namecode Command Permet d indiquer si un e- mail de rappel d identifiants de connexion doit être envoyé au registrant. (Adresse spécifiée dans _registrant) Identifiant du nouveau contact revendeur. Pour transférer un domaine chez Namebay veuillez spécifier «NB1», pour un autre revendeur, le contacter. Ce paramètre est utilisé comme sécurité en cas de transfert in. Mettre la valeur null en cas de transfert out. Le NameCode se récupère dans l interface de gestion de vos domaines. [ ] <command> <reseller_transfert> <name>...</name> < _registrant>...</ _registrant> <send >...</send > <newresellercontact>...</newresellercontact> <namecode>...</namecode> </reseller_transfert> </command> String (True or False) String String Yes Yes No Response <?xml version="1.0" encoding="utf-8"?> <api> <response> <trid> </trid> <result code=" "> <msg> </msg> <value> </value> </result> </response> Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 11

12 Contact_check Vérification de la disponibilité d un identifiant de contact. Paramètres entrants Description Type Obligatoire contact_id Identifiant de contact String (min 3, max 10) Paramètres sortants Description Valeurs possibles status contact_id Statut du domaine Identifiant du contact AVAILABLE (disponible), ou UNAVAILABLE (indisponible) Commande [ ] <command> <contact_check> <contact_id> </contact_id> </contact_check> </command> Réponse <?xml version="1.0" encoding="utf-8"?> <api> <response> <trid> </trid> <result code=" "> <msg> </msg> </result> </response> <resdata> <contact_chkdata> <contact_id available=" "> </contact_id> </contact_chkdata> </resdata> Code Erreurs Code Paramètre Message Valeur Commentaire 501 contact_id command syntax The 'contact_id' element has an invalid value according to its data type String (min 3, max 10) Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 12

13 Création d'un contact Contact_create V7.12 Paramètres entrants is_individual Description Type Expression régulière Obligatoire Type d utilisateur firstname Prénom String lastname Nom String orgname Nom de l organisation Boolean. Valeurs : particulier = 1 ; organisation = 0. String street Adresse 1 String street2 Adresse 2 String city Ville String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,150} [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,150} [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,150} [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,250} [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,250} [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,150} pc Code postal String [ a-za-z0-9._#/-]{1,30} Si le champ is_individual = 0 Non sp Povince ou état String [A-Za-z0-9 \.\-!#$%'()*+,:;=?@[\]//^_` }{]{0,80} Non cc Code du pays String [A-Za-z]{2} voice fax Numéro de téléphone Fax Adresse String password Mot de passe String (format : code téléphone pays + «.» + numéro de téléphone) String (format : code téléphone pays + «.» + numéro de fax) String (min 5, max 15) \+[0-9]{1,3}\.[0-9]{1,15} \+[0-9]{1,3}\.[0-9]{1,15} Non [0-9a-zA-Z_\.-]+@(([0-9]{1,3}\.){3}[0-9]{1,3} ([0-9a-zA- Z][A-Z0-9a-z-]*[0-9a-zA-Z]\.)+[a-zA- Z]{2,7}) birthday Date Non Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 13

14 Paramètres entrants place_of_birth number type="s" number type="m" Intracom V7.12 Description Type Expression régulière Obligatoire si FR : code postal, ville si autre : code pays (BE, DE, ) N SIREN String [0-9]{9} Non N Marque String [0-9]{9} Non N TVA intracommunautaire String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,50} Non Non Paramètres entrants * (uniquement pour.fr) duns Description Type Expression régulière Data Universal Numbering System localnumber Numéro identifiant local String assowaldec Numéro identifiant association String [0-9]{9} Non String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,50} [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,50} assocreationdate Date création association date Non assodeclarationdate Date déclaration préfecture association assopubannounce N annonce journal officiel short Non assopubpage N page journal officiel short Non date Obligatoire Non Non Non * Un nom de domaine.fr ne peut être enregistré que par des citoyens européens ou des résidents, ainsi que par toute entreprise ou organisation européenne. Une des conditions d'admissibilité suivantes doit être remplie : Personne physique 1. Être citoyen ou résident permanent en Europe (birthday, place_of_birth) Personne morale 1. Être implanté dans l'un des pays Européen (Entreprise : N SIREN ou N Marque ou N TVA intracommunautaire ou N duns ou N localnumber) (Association : N assowaldec ou [assocreationdate et assodeclarationdate et assopubannounce et assopubpage]) Paramètres entrants * (uniquement pour.us) nexus_purpose Type d utilisation Valeur à transmettre Type Commerciale P1 String (2) Association P2 String (2) Usage personnel P3 String (2) Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 14

15 Paramètres entrants * (uniquement pour Type d utilisation Valeur à transmettre Type.US) Education P4 String (2) Gouvernementale P5 String (2) nexus_cat Un résident étranger aux US C12 String (3) Vous n'êtes pas américain mais vous avez des relations commerciales aux USA C32 String (3) Vous n'êtes pas américain mais vous avez un bureau aux USA V7.12 C31 String (3) * Un nom de domaine.us ne peut être enregistré que par des citoyens américains ou des résidents américains, ainsi que par toute entreprise ou organisation, fédérale, nationale ou locale, avec une présence locale aux États-Unis. Une des conditions d'admissibilité suivantes doit être remplie : Personne physique 1. être citoyen ou résident permanent aux États-Unis d'amérique, ou dans l'une de ses possessions ou territoires ou 2. avoir sa résidence principale aux Etats-Unis d'amérique ou dans l'une de ses possessions Personne morale 1. être implanté dans l'un des 50 états des États-Unis, ou dans le District de Columbia, ou dans l'une des possessions ou territoires des États-Unis ou 2. avoir été organisé ou au moins constitué en vertu de la législation d'un État des États-Unis d'amérique, le District de Columbia, ou une de ses possessions ou territoires Entité ou organisation Une entité ou une organisation (y compris du gouvernement fédéral, d'état ou des collectivités locales des États-Unis, ou d une de ses subdivisions politiques) disposant d une présence locale aux États-Unis. Paramètres entrants * (uniquement pour.it) Description Type Expression régulière Obligatoire intracom N TVA intracommunautaire String passport Numéro de passeport String identitycard Numéro identité String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,50} Si Personne morale Si Personne physique Si Personne physique * Un nom de domaine.it ne peut être enregistré que par des citoyens européens. Une des conditions d'admissibilité suivantes doit être remplie : Personne physique 1. Disposer d un numéro d identité ou d un numéro de passeport Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 15

16 Personne morale 2. Disposer d un numéro intracommunautaire V7.12 Paramètres entrants (uniquement pour.pt) Description Type Expression régulière Obligatoire intracom N TVA intracommunautaire String number type="s" N SIREN String [0-9]{9} number type="m" N Marque String [0-9]{9} [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,50} Si Personne morale et number non rempli Si Personne morale et intracom non rempli Si Personne morale et intracom non rempli Une des conditions d'admissibilité suivantes doit être remplie : Personne morale 1. Disposer d un numéro de TVA intracommunautaire 2. Disposer d un numéro SIREN (ou numéro d'enregistrement de société) ou d'un numéro de Marque contact_id Paramètres sortants Description Identifiant du contact, généré par sa création Commande [ ] <command> <contact_create> <is_individual> </is_individual> <firstname> </firstname> <lastname> </lastname> <street> </street> <city> </city> <pc> </pc> <cc> </cc> <voice> </voice> < > </ > <password> </password> si le client est un particulier <birthday> </birthday> <place_of_birth> </place_of_birth> ou si le client est une société <number type="s"> </number>> </contact_create> Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 16

17 </command> Réponse <?xml version="1.0" encoding="utf-8"?> <api> <response> <trid> </trid> <result code=" "> <msg> </msg> </result> </response> <resdata> <contact_credata> <contact_id> </contact_id> </contact_credata> </resdata> Code erreur Code Paramètre Message Valeur Commentaire 501 is_individual command syntax The 'is_individual' element has an invalid value according to its data type Possible values : particulier = 1 ; organisation = firstname command syntax The 'firstname' element has an invalid value according to its data type Possible values :[A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,150} 501 lastname 501 orgname 501 street 501 street2 501 city command syntax command syntax command syntax command syntax command syntax The 'lastname' element has an invalid value according to its data type The 'orgname' element has an invalid value according to its data type The 'street' element has an invalid value according to its data type The 'street2' element has an invalid value according to its data type The 'city ' element has an invalid value according to its data type Possible values :[A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,150} Possible values : [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,150} Possible values : [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,250} Possible values : [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,250} Possible values : [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,150} 501 pc command The 'pc' element has an Possible values : Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 17

18 501 sp 501 cc syntax command syntax command syntax invalid value according to its data type The 'sp' element has an invalid value according to its data type The 'cc' element has an invalid value according to its data type [ a-za-z0-9._#/-]{1,30} Possible values : [A-Za-z0-9 \.\-!#$%'()*+,:;=?@[\]//^_` }{]{0,80} Possible values : [A-Za-z]{2} 501 cc Sémantique. The 'cc' element has an invalid semantique value Valeur inconnue 501 voice command syntax The 'voice' element has an invalid value according to its data type Possible values : String (format : code téléphone pays + «.» + numéro de téléphone) format international ISO (par exemple ) \+[0-9]{1,3}\.[0-9]{1,15} 501 fax password 501 birthday 501 place_of_birth 501 number type="s" 540 orgname 550 place_of_birth 550 place_of_birth command syntax command syntax command syntax command syntax command syntax command syntax parameter value parameter value policy parameter value policy The 'fax' element has an invalid value according to its data type The ' ' element has an invalid value according to its data type The 'password' element has an invalid value according to its data type The 'birthday' element has an invalid value according to its data type The 'place_of_birth' element has an invalid value according to its data type The 'number' element has an invalid value according to its data type Required parameter missing (orgname: range(1-100) FR is not allowed, you should specify postal code and city Invalid Place of Birth, should be BE or 75, paris Possible values : String (format : code téléphone pays + «.» + numéro de fax) \+[0-9]{1,3}\.[0-9]{1,15} Possible values : format défini par le RFC2822 [0-9a-zA-Z_\.-]+@(([0-9]{1,3}\.){3}[0-9]{1,3} ([0-9a-zA-Z][A-Z0-9a-z-]*[0-9a-zA- Z]\.)+[a-zA-Z]{2,7}) Possible values : String (min 5, max 15) Possible values : Date Possible values : String : si FR : code postal, ville si autre : code pays (BE, DE, ) Possible values : N SIREN Le champ OrgName est obligatoire lorsque le champs is_individual = 0 Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 18

19 or 75008, paris 550 cc 550 Pc, city (cc) parameter value policy parameter value policy invalid code country Postal code does not match the city Dans le pays du contact, la ville ne correspond pas au code postal Suppression d un contact. Contact_delete Paramètres entrants Description Type Obligatoire contact_id Identifiant de contact String (min 3, max 10) Paramètres sortants Description contact_id Identifiant du contact supprimé Commande [ ] <command> <contact_delete> <contact_id> </contact_id> </contact_delete> </command> Réponse <?xml version="1.0" encoding="utf-8"?> <api> <response> <trid> </trid> <result code=" "> <msg> </msg> </result> </response> <resdata> <contact_deldata> <contact_id available=" "> </contact_id> </contact_deldata> </resdata> Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 19

20 Code erreurs Code Paramètre Message Valeur Commentaire 501 contact_id command syntax 503 contact_id authorization failed The 'contact_id' element has an invalid value according to its data type not reseller of this contact(handle) / contact linked with objects String (min 3, max 10) 510 contact_id object does not exist contact_id (handle) Contact_info Affichage les informations d un contact. Paramètres entrants Description Type Obligatoire contact_id Identifiant de contact String (min 3, max 10) Paramètres sortants contact_id password firstname lastname orgname street city pc sp cc voice Description Identifiant de contact saisi par l utilisateur Mot de passe du contact Prénom du contact Nom du contact Nom de l organisation du contact Rue, voie du contact Ville du contact Code postal du contact Pays du contact Code pays du contact Téléphone du contact Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 20

21 Paramètres sortants Description du contact Commande [ ] <command> <contact_info> <contact_id> </contact_id> </contact_info> </command> Réponse <?xml version="1.0" encoding="utf-8"?> <api> <response> <trid> </trid> <result code=" "> <msg> </msg> </result> </response> <resdata> <contact_infdata> <contact_id> </contact_id> <password>...</password> <firstname> </firstname> <lastname> </lastname> <orgname> </orgname> <street> </street> <city> </city> <pc> </pc> <sp> </sp> <cc> </cc> <voice> </voice> < > </ > </contact_infdata> </resdata> Code Erreurs Code Paramètre Message Valeur Commentaire 501 contact_id command syntax The 'contact_id' element has an invalid value according to its data type String (min 3, max 10) Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 21

22 510 contact_id object does not exist contact_id (handle) Contact_update Mise à jour d'un contact. Paramètres entrants contact_id Description Type Expression régulière Obligatoire Identifiant de contact String (min 3, max 10) street Adresse 1 String Street2 Adresse 2 String city Ville String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,250} [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,250} [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,150} pc Code postal String [ a-za-z0-9._#/-]{1,30} sp Povince ou état String voice fax Téléphone Fax (format : code téléphone pays + «.» + numéro de fax) Adresse String password Mot de passe String (format : code téléphone pays + «.» + numéro de téléphone) String (format : code téléphone pays + «.» + numéro de fax) String (min 5, max 15) [A-Za-z0-9 \.\-!#$%'()*+,:;=?@[\]//^_` }{]{0,80} Non Non \+[0-9]{1,3}\.[0-9]{1,15} \+[0-9]{1,3}\.[0-9]{1,15} Non [0-9a-zA-Z_\.-]+@(([0-9]{1,3}\.){3}[0-9]{1,3} ([0-9a-zA- Z][A-Z0-9a-z-]*[0-9a-zA-Z]\.)+[azA-Z]{2,7}) birthday Date Non place_of_birth number type="s" number type="m" Intracom si FR : code postal, ville si autre : code pays (BE, DE, ) N SIREN String [0-9]{9} Non N Marque String [0-9]{9} Non N TVA intracommunautaire String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,50} Non Non Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 22

23 Paramètres entrants * (uniquement pour.fr) duns Description Type Expression régulière Data Universal Numbering System localnumber Numéro identifiant local String assowaldec Numéro identifiant association String [0-9]{9} Non String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,50} [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,50} assocreationdate Date création association date Non assodeclarationdate Date déclaration préfecture association assopubannounce N annonce journal officiel short Non assopubpage N page journal officiel short Non date Obligatoire Non Non Non * Un nom de domaine.fr ne peut être enregistré que par des citoyens européens ou des résidents, ainsi que par toute entreprise ou organisation européenne. Une des conditions d'admissibilité suivantes doit être remplie : Personne physique 1. Être citoyen ou résident permanent en Europe (birthday, place_of_birth) Personne morale 1. Être implanté dans l'un des pays Européen (Entreprise : N SIREN ou N Marque ou N TVA intracommunautaire ou N duns ou N localnumber) (Association : N assowaldec ou [assocreationdate et assodeclarationdate et assopubannounce et assopubpage]) Paramètres entrants * (uniquement pour Type d utilisation Valeur à transmettre Type.US) Commerciale P1 String (2) Association P2 String (2) nexus_purpose Usage personnel P3 String (2) Education P4 String (2) Gouvernementale P5 String (2) nexus_cat Un résident étranger aux US C12 String (3) Vous n'êtes pas américain mais vous avez des relations C32 String (3) commerciales aux USA Vous n'êtes pas américain mais vous avez un bureau aux USA C31 String (3) * Un nom de domaine.us ne peut être enregistré que par des citoyens américains ou des résidents Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 23

24 américains, ainsi que par toute entreprise ou organisation, fédérale, nationale ou locale, avec une présence locale aux États-Unis. Une des conditions d'admissibilité suivantes doit être remplie : Personne physique 1. être citoyen ou résident permanent aux États-Unis d'amérique, ou dans l'une de ses possessions ou territoires ou 2. avoir sa résidence principale aux Etats-Unis d'amérique ou dans l'une de ses possessions Personne morale 1. être implanté dans l'un des 50 états des États-Unis, ou dans le District de Columbia, ou dans l'une des possessions ou territoires des États-Unis ou 2. avoir été organisé ou au moins constitué en vertu de la législation d'un État des États-Unis d'amérique, le District de Columbia, ou une de ses possessions ou territoires Entité ou organisation Une entité ou une organisation (y compris du gouvernement fédéral, d'état ou des collectivités locales des États-Unis, ou d une de ses subdivisions politiques) disposant d une présence locale aux États-Unis. V7.12 Paramètres entrants * (uniquement pour.it) Description Type Expression régulière Obligatoire intracom N TVA intracommunautaire String passport Numéro de passeport String identitycard Numéro identité String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,50} Si Personne morale Si Personne physique Si Personne physique * Un nom de domaine.it ne peut être enregistré que par des citoyens européens. Une des conditions d'admissibilité suivantes doit être remplie : Personne physique 1. Disposer d un numéro d identité ou d un numéro de passeport Personne morale 2. Disposer d un numéro intracommunautaire Paramètres entrants (uniquement pour.pt) Description Type Expression régulière Obligatoire intracom N TVA intracommunautaire String number type="s" N SIREN String [0-9]{9} number type="m" N Marque String [0-9]{9} [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,50} Si Personne morale et number non rempli Si Personne morale et intracom non rempli Si Personne morale et intracom non rempli Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 24

25 Une des conditions d'admissibilité suivantes doit être remplie : Personne morale 1. Disposer d un numéro de TVA intracommunautaire 2. Disposer d un numéro SIREN (ou numéro d'enregistrement de société) ou d'un numéro de Marque Paramètres sortants Description contact_id Identifiant du contact modifié Commande [ ] <command> <contact_update> <contact_id> </contact_id> <street> </street> <city> </city> <pc> </pc> <voice> </voice> < > </ > <password> </password> </contact_update> </command> Réponse <?xml version="1.0" encoding="utf-8"?> <api> <response> <trid> </trid> <result code=" "> <msg> </msg> </result> </response> <resdata> <contact_updata> <contact_id> </contact_id> </contact_updata> </resdata> Code Erreurs Code Paramètre Message Valeur Commentaire Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 25

26 501 contact_id 501 street 501 street2 501 city 501 pc 501 sp 501 voice 501 fax 501 command syntax command syntax command syntax command syntax command syntax command syntax command syntax command syntax command syntax 502 password authorization failed 503 contact_id authorization failed 550 place_of_birth parameter value policy V7.12 The contact_id' element has an invalid value according to its data type The 'street' element has an invalid value according to its data type The 'street2' element has an invalid value according to its data type The 'city ' element has an invalid value according to its data type The 'pc' element has an invalid value according to its data type The 'sp' element has an invalid value according to its data type The 'voice' element has an invalid value according to its data type The 'fax' element has an invalid value according to its data type The ' ' element has an invalid value according to its data type invalid login or password not reseller of this contact(handle) / contact linked with objects FR is not allowed, you should specify postal code and city String (min 3, max 10) Possible values : [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,250} Possible values : [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,250} Possible values : [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_` }{]{1,150} Possible values : [ a-za-z0-9._#/-]{1,30} Possible values : [A-Za-z0-9 \.\-!#$%'()*+,:;=?@[\]//^_` }{]{0,80} Possible values : String (format : code téléphone pays + «.» + numéro de téléphone) format international ISO (par exemple ) \+[0-9]{1,3}\.[0-9]{1,15} Possible values : String (format : code téléphone pays + «.» + numéro de fax) \+[0-9]{1,3}\.[0-9]{1,15} Possible values : format défini par le RFC2822 [0-9a-zA-Z_\.-]+@(([0-9]{1,3}\.){3}[0-9]{1,3} ([0-9a-zA- Z][A-Z0-9a-z-]*[0-9a-zA-Z]\.)+[azA-Z]{2,7}) Le contact n est pas lié au revendeur. Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 26

27 550 place_of_birth parameter value policy V7.12 Invalid Place of Birth, should be BE or 75, paris or 75008, paris Domain_check Vérification de la disponibilité d un nom de domaine. Paramètres entrants Description Type Expression régulière Obligatoire name Nom de domaine String [A-Za-z0-9-\.]{5,68} Paramètres sortants Description Valeurs possibles status Statut du domaine AVAILABLE = 0 (Nom de domaine non disponible à l enregistrement chez le registre) AVAILABLE = 1 (Nom de domaine disponible à l enregistrement chez le registre) name Nom de domaine Code Erreurs Code d erreur Paramètre Message Valeur Commentaire 501 name Command syntax The 'name' element has an invalid value according to its data type La balise name est vide ou son contenu n a pu être validé par l expression régulière Commande [ ] <command> <domain_check> <name> </name> </domain_check> </command> Réponse <?xml version="1.0" encoding="utf-8"?> <api> <response> <trid> </trid> <result code=" "> <msg> </msg> Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 27

28 </result> </response> <resdata> <domain_chkdata> <name available=" "> </name> </domain_chkdata> </resdata> Domain_check_multi Vérification de la disponibilité d une liste de noms de domaine. Paramètres entrants Description Type Expression régulière Obligatoire listname Liste de noms de domaine String ([A-Za-z0-9-\.]{5,68},)+ (ex : titi.com, toto.fr, tata.pt, titi.net) Paramètres sortants Description Valeurs possibles name Nom de domaine AVAILABLE = 0(disponible) AVAILABLE =1 (indisponible) AVAILABLE =Error (erreur) Code Erreurs Code d erreur Paramètre Message Valeur Commentaire 501 listname Command syntax The 'listname' element has an invalid value according to its data type La balise name est vide ou son contenu n a pu être validé par l expression régulière Commande [ ] <command> <domain_check_multi> <listname> </listname> </domain_check_multi > </command> Réponse <?xml version="1.0" encoding="utf-8"?> <api> Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 28

29 <response> <trid> </trid> <result code=" "> <msg> </msg> </result> </response> <resdata> <domain_chkdata> <name available=" "> </name>. <name available=" "> </name> </domain_chkdata> </resdata> Domain_create Création d un nom de domaine. Paramètres entrants Description Type contact type='registrant' contact type='admin' contact type='tech' contact type='billing' Identifiant du contact propriétaire du nom de domaine Identifiant du contact administratif du nom de domaine Identifiant du contact technique du nom de domaine Identifiant du contact de facturation du nom de domaine name Nom de domaine String period Nombre d années d enregistrement du nom de domaine ns Serveur de noms String public number_type Rendre les informations publiques Justificatif utilisé pour l enregitrement du String (max 10) String (max 10) String (max 10) String (max 10) Int (min 1, max 10) String (min 0, max 1) valeur : 0 ou 1 string Expression régulière [A-Za-z0-9- \.]{5,68} [A-Za-z0-9- \.]{5,150} (Min 2, max 6) siren mark Obligatoire seulement pour les «.fr» si le registrant est un particulier Non seulement pour les «.fr» Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 29

30 Paramètres entrants Description Type number_value uin registration_phase TrusteeService domaine.fr : Siren ou Marque. Valeur du justificatif pour l enregistrement du domaine.fr Code d autorisation d enregistrement d un domaine.travel Phase de préenregistrement Permet de definer si la presence locale peut être utilisée string string Boolean Expression régulière Obligatoire si le registrant est une société permet de mettre à jour le siren ou la marque du registrant sans avoir à effectuer une modification de contact préalablement. seulement pour les «.fr» si number_type est renseigné seulement pour les domaines.travel Uniquement lors des phases de préenregistrement. Se référer à la documentation émise pour l occasion. Non Paramètres sortants Description Valeurs possibles name status credate expdate Code Erreurs Nom de domaine Statut du nom de domaine Date de création du domaine Date d expiration du domaine «registered» Code d erreur Paramètre Message Valeur Commentaire 501 contact Command The 'contact' element La balise contact est vide ou Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 30

31 Code d erreur Paramètre Message Valeur Commentaire 501 type='registrant' syntax has an invalid value according to its data type contact type='admin' 501 contact type='tech' name contact type='billing' 501 period 501 ns 501 public 550 name 550 period 550 name Command syntax Command syntax Command syntax Command syntax Command syntax Command syntax Command syntax parameter value policy parameter value policy parameter value policy The 'contact' element has an invalid value according to its data type The 'contact' element has an invalid value according to its data type The 'contact' element has an invalid value according to its data type The 'name' element has an invalid value according to its data type The 'period' element has an invalid value according to its data type The 'period' element has an invalid value according to its data type The 'public' element has an invalid value according to its data type domainname (xxxxxx.yy) illegal registration period Invalid tldname son contenu n a pu être validé par l expression régulière La balise contact est vide ou son contenu n a pu être validé par l expression régulière La balise contact est vide ou son contenu n a pu être validé par l expression régulière La balise contact est vide ou son contenu n a pu être validé par l expression régulière La balise name est vide ou son contenu n a pu être validé par l expression régulière La balise period est vide ou son contenu n a pu être validé par l expression régulière La balise period est vide ou son contenu n a pu être validé par l expression régulière La balise public est vide ou son contenu n a pu être validé par l expression régulière Le nom de domaine n est pas pris en charge Ex : Namebay.ZZ (l extension.zz n est pas permise) La période d enregistrement est invalide Ex : 2 ans (ou plus) n est pas possible pour un domaine.fr Le nom de domaine, bien que valide syntaxiquement, ne peut être enregistré car le fournisseur de l extension n existe pas. Ex : «Domaine.zz» est syntaxiquement correcte mais Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 31

32 Code d erreur Paramètre Message Valeur Commentaire 550 uin 550 Registration_phase contact type='registrant' contact type='registrant' contact type='registrant' contact type='registrant' parameter value policy parameter value policy parameter value policy parameter value policy parameter value policy parameter value policy (.Travel) missing uin 'number' Invalid Registration phase (test) registrant must be european registrant have to live in France Birthday of this contact does not match with your tag Legal Age should be more than 18 le «.zz» n est pas vendu par Namebay. Le code UIN, obligatoire pour enregistrer un domaine.travel, n a pas été fourni. La phase d enregistrement est invalide Ce paramètre n est utilisé que pour le pré-enregistrement de noms de domaine. Le contenu de ce champ est variable et fait l objet d une documentation fournie spécifiquement pour ce préenregistrement. Par le passé, les valeurs possibles ont été : «sunrise», «landruch» ou «ongoing» Pour enregistrer un domaine.eu, le registrant doit résider en Europe. Pour enregistrer un domaine.fr, le registrant particulier doit résider en France. Pour enregistrer un domaine.fr, le registrant particulier doit avoir spécifié une date de naissance. Pour enregistrer un domaine.fr, le registrant particulier doit être majeur. 550 place_of_birth 550 place_of_birth 550 place_of_birth 550 place_of_birth parameter value policy parameter value policy parameter value policy parameter value policy FR is not allowed, you should specify postal code and city place_of_birth of this contact does not match with your tag Invalid Place of Birth, should be BE or 75, paris or 75008, paris place_of_birth have to be specified in the contact or in the place_of_birth tag Pour enregistrer un domaine.fr, le registrant particulier né en France (FR) doit avoir spécifié un code postal et une ville de naissance. Le lieu de naissance du contact registrant ne correspond pas avec celui fourni dans le parameter place_of_birth Le format du lieu de naissance est incorrect. Le parametre place_of_birth est vide. Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 32

33 Code d erreur Paramètre Message Valeur Commentaire 550 number 525 name contact type='registrant' contact type='admin' 510 contact type='tech' 510 contact type='billing' parameter value policy object already registered object does not exist object does not exist object does not exist object does not exist Siren of this contact does not match with your tag domainname (namebay.fr) contact_id (xxx) contact_id (xxx) contact_id (xxx) contact_id (xxx) Le siren renseigné dans le champ number ne correspond pas au siren actuel du contact Le domaine Namebay.fr est déjà enregistré. Le contact xxx n existe pas Le contact xxx n existe pas Le contact xxx n existe pas Le contact xxx n existe pas Commande [ ] <command> <domain_create> <contact type='registrant'> </contact> <contact type='admin'> </contact> <contact type='tech'> </contact> <contact type='billing'> </contact> <name> </name> <ns> </ns> <ns> </ns> <period> </period> </domain_create> </command> Réponse <?xml version="1.0" encoding="utf-8"?> <api> <response> <trid> </trid> <result code=" "> <msg> </msg> </result> </response> <resdata> <domain_credata> <name> </name> <status> </status> <credate> </credate> <expdate> </expdate> Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 33

34 </domain_credata> </resdata> Domain_info Affichage des informations sur un nom de domaine enregistré chez Namebay. Paramètres entrants Description Type Expression régulière Obligatoire name Nom de domaine String [A-Za-z0-9-\.]{5,68} Paramètres sortants Description Valeurs possibles name status credate expdate registrant_name registrant_street registrant_city registrant_pc registrant_cc registrant_ admin_contact_id Nom de domaine Statut du nom de domaine Date de création du domaine Date d expiration du domaine Nom du contact propriétaire du domaine Adresse du contact propriétaire Ville du contact propriétaire Code postal du contact propriétaire Code pays du contact propriétaire Adresse du contact propriétaire Identifiant du contact administratif du nom de domaine Active : domaine actif; ok : domaine actif; protected :domaine interdit au transfert; lock : domaine vérouillé; «pending transfer» : domaine en cours de transfert; «expired»: domaine expiré; «redemptionperiod» : domaine en période de rédemption; «hold»: domaine suspendu Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 34

35 Paramètres sortants Description Valeurs possibles admin_firstname admin_lastname admin_orgname admin_street admin_city admin_pc admin_cc admin_voice admin_fax admin_ tech_contact_id tech_firstname tech_lastname tech_orgname tech_street tech_city tech_pc tech_cc tech_voice tech_fax tech_ billing_contact_id Prénom du contact administratif du domaine Nom du contact administratif du domaine Nom de l organisation du contact administratif Adresse du contact administratif Ville du contact administratif Code postal du contact administratif Code pays du contact administratif Numéro de téléphone du contact administratif Numéro de fax du contact administratif Adresse du contact administratif Identifiant du contact technique du nom de domaine Prénom du contact technique Nom du contact technique Nom de l organisation du contact technique Adresse du contact technique Ville du contact technique Code postal du contact technique Code pays du contact technique Numéro de téléphone du contact technique Numéro de fax du contact technique Adresse du contact technique Identifiant du contact de facturation Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 35

36 Paramètres sortants Description Valeurs possibles billing_firstname billing_lastname billing_orgname billing_street billing_city billing_pc billing_cc billing_voice billing_fax billing_ Ns Ns Prénom du contact de facturation Nom du contact de facturation Nom de l organisation du contact de facturation Adresse du contact de facturation Ville du contact de facturation Code postal du contact de facturation Code pays du contact de facturation Numéro de téléphone du contact de facturation Numéro de fax du contact de facturation Adresse du contact de facturation Nom du premier serveur de noms du nom de domaine Nom du second serveur de noms du nom de domaine Si vous n êtes pas le revendeur du nom de domaine, des informations réduites seront retournées : Paramètres sortants Description Valeurs possibles name status credate expdate Nom de domaine Statut du nom de domaine Date de création du domaine Date d expiration du domaine Active : domaine actif; ok : domaine actif; protected :domaine interdit au transfert; lock : domaine vérouillé; «pending transfer» : domaine en cours de transfert; «expired»: domaine expiré; «redemptionperiod» : domaine en période de rédemption; «hold»: domaine suspendu Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 36

37 Code Erreurs Code d erreur Paramètre Message Valeur Commentaire 501 name 550 name 510 name Command syntax parameter value policy object does not exist The 'name' element has an invalid value according to its data type domainname (xxxxxx.yy) La balise name est vide ou son contenu n a pu être validé par l expression régulière Le nom de domaine n est pas pris en charge Ex : Namebay.ZZ (l extension.zz n est pas permise) Le nom de domaine demandé n existe pas. Commande [ ] <command> <domain_info> <name> </name> </domain_info> </command> Réponse <?xml version="1.0" encoding="utf-8"?> <api> <response> <trid> </trid> <result code=" "> <msg> </msg> </result> </response> <resdata> <domain_infdata> <name> </name> <status> </status> <credate> </credate> <expdate> </expdate> <registrant_name> </registrant_name> <registrant_street> </registrant_street> <registrant_city> </registrant_city> <registrant_pc> </registrant_pc> <registrant_cc> </registrant_cc> <registrant_ > </registrant_ > <admin_contact_id> </admin_contact_id> <admin_firstname> </admin_firstname> <admin_lastname> </admin_lastname> Tous les droits de copie, de diffusion de ce document sont la propriété exclusive de la société SAM NAMEBAY. 37

Montrer encore