WebServices Netissime v1.8 Liste des fonctionnalités. Descriptif Webservices Netissime.com v1.8

Transcription

1 Descriptif Webservices Netissime.com v1.8 1/29

2 I. class client function existing($resid, $resuser, $respwd, $mail) string $mail * : mail du compte client string [result] TRUE si le déroulement du webservice s'est effectué avec succès identifiant du compte client correspondant à l'adresse passée en paramètre NULL si aucun compte client n'etre trouvé Cette méthode vérifie si un compte client correspondant à l'adresse passée en paramètre existe. Si un compte client est trouvé l'identifiant du compte est retourné. 2/29

3 function add($resid, $resuser, $respwd, $cnom, $cprenom, $csociete, $cadresse, $czip, $cville, $ctel, $cfax, $cmail, $cpays, $ccivilite, $cportable) string $cnom * : nom du compte client à créer ^([a-za-z ]*)$ string $cprenom * : prénom du compte client à créer ^([a-za-z ]*)$ string $csociete : société du compte client à créer ^([a-za-z0-9 ]*)$ string $cadresse * : adresse du compte client à créer ^([a-za-z0-9,]*)$ string $czip * : code postal du compte client à créer ^([a-za-z0-9 ]*)$ string $cville * : ville du compte client à créer ^([a-za-z ]*)$ string $ctel * : téléphone du compte client à créer ^[0-9]2\.[0-9]9$ string $cfax : fax du compte client à créer ^[0-9]2\.[0-9]9$ string $cmail * : mail du compte client à créer string $cpays * : code pays ISO du compte client à créer ^[A-Z]2$ string $ccivilite : civilité du compte client à créer ^[M Mme Mlle]$ string $cportable : portable du compte client à créer ^[0-9]2\.[0-9]9$ string [result] TRUE si l'exécution du webservice s'est déroulée avec succès identifiant du compte client créé ou NULL si le compte n'a pu être créé Cette méthode créé le compte client correspondant aux informations passées en paramètre. Avant l'insertion, une vérification est effectuée afin de controler qu'aucun compte client ne possède la même adresse . Si un compte client possède l'adresse passée, la création est annulée. function modification($resid, $resuser, $respwd, $cid, $cnom, $cprenom, $csociete, $cadresse, $czip, $cville, $ctel, $cfax, $cmail, $cpays, $ccivilite, $cportable) 3/29

4 string $cid * : identifiant du compte client à modifier string $cnom * : nom du compte client à créer ^([a-za-z ]*)$ string $cprenom * : prénom du compte client à créer ^([a-za-z ]*)$ string $csociete : société du compte client à créer ^([a-za-z0-9 ]*)$ string $cadresse * : adresse du compte client à créer ^([a-za-z0-9,]*)$ string $czip * : code postal du compte client à créer ^([a-za-z0-9 ]*)$ string $cville * : ville du compte client à créer ^([a-za-z ]*)$ string $ctel * : téléphone du compte client à créer ^[0-9]2\.[0-9]9$ string $cfax : fax du compte client à créer ^[0-9]2\.[0-9]9$ string $cmail * : mail du compte client à créer string $cpays * : code pays du compte client à créer ^[A-Z]2$ string $ccivilite : civilité du compte client à créer ^(M Mme Mlle)$ string $cportable : portable du compte client à créer ^[0-9]2\.[0-9]9$ boolean [status ] TRUE si l'exécution du webservice s'est déroulée avec succès TRUE si la modification du compte client s'est effectuée avec succès FALSE dans le cas contraire Cette méthode effectue la mise à jour des informations concernant un compte client function get_info($resid, $resuser, $respwd, $cid) string $cid * : identifiant du compte client [status] TRUE si l'exécution du webservice s'est déroulée avec succès 4/29

5 [result] string [nom] string [prenom] string [societe] string [adresse] string [zip] string [ville] string [tel] string [fax] string [mail] string [pays] string [civilite] string [portable] nom du compte client prenom du compte client societe du compte client adresse du compte client code postal du compte client ville du compte client telephone du compte client fax du compte client mail du compte client code pays du compte client civilite du compte client portable du compte client Cette méthode récupère les informations d'un compte client partenaire dont l'identifiant est passé en paramètre. function delete($resid, $resuser, $respwd, $cid) string $cid * : identifiant du compte client string [status] string result] TRUE si l'exécution du webservice s'est déroulée avec succès TRUE si la suppression du compte client s'est effectuée avec succès FALSE dans le cas contraire Cette méthode supprime le compte client dont l'identifiant est passé en paramètre, l'intégralité des produits rattachés au compte client sont également supprimés. 5/29

6 function merge($resid, $resuser, $respwd, $cid1, $cid2) string $cid1 * : identifiant du 1er compte client string $cid2 * : identifiant du 2eme compte client TRUE si l'exécution du webservice s'est déroulée avec succès TRUE si la fusion a été effectuée FALSE dans le cas contraire Cette méthode fusionne deux comptes client partenaire. L'intégralité des produits et factures du 2eme compte client sont rappatriés sur le 1er compte client. II. class domain function creation($resld, $resuser, $respwd, $cld, $domain, $year, $infos, $infos_fr) Variables en entrée : string $resld * : identifiant du revendeur string $cld * : identifiant du client du revendeur 6/29

7 string $domain * : nom de domaine à enregistrer int $year * : durée de réservation du nom de domaine array $infos string [cld] identifiant du client déjà enregistré si les informations du propriétaire correspondent aux informations de facturation enregistrées lors de la création du compte client si l'identifiant est passé le service va récupérer les informations enregistrées pour cet id si le cld est renseigné les informations suivantes sont inutiles string [Nom] string [Prénom] string [société] string [Adresse] string [Zip] string [Ville] nom du propriétaire du nom de domaine prénom du propriétaire du nom de domaine société propriétaire du nom de domaine adresse du propriétaire du nom de domaine code postal du propriétaire du nom de domaine ville du propriétaire du nom de domaine string [Tel] string [Fax] téléphone du propriétaire du nom de domaine fax du propriétaire du nom de domaine string [Mail] string [Pays] du propriétaire du nom de domaine pays du propriétaire du nom de domaine array $infos_fr string [type_depot] type de titulaire ^(particulier societe association marque)$ date [date_naissance] date de naissance ^([0-9]4)\-([0-9]2)\-([0-9]2)$ string [pays_naissance] pays de naissance ^([A-Z]2)$ string [zip_naissance] code postal de naissance ^([0-9]5)$ string [commune_naissance] commune de naissance ^[0-9a-zA-Z\- ]* int [siren] n siren de la société ^([0-9]9)$ int [insee] n insee de l'association ^([0-9]9)$ int [inpi] n inpi de la marque ^([0-9]9)$ [status] [result] TRUE si la demande d'enregistrement du nom de domaine a été prise en compte 7/29

8 Cette méthode enregistre une demande de création pour le nom de domaine passé en paramètre. Il est possible de passer l'identifiant d'un client déjà enregistré si les informations du propriétaire correspondent aux informations de facturation enregistrées lors de la création du compte client, si l'identifiant est passé le service va récupérer les informations enregistrées pour cet id et les utilisent pour l'enregistrement du nom de domaine. La variable $infos_fr contient les informations nécessaires lors de l'enregistrement d'un nom de domaine en.fr, elle est donc facultative lors de l'enregistrement d'un nom de domaine possédant une extension autre que.fr. function reload_creation($resld, $resuser, $respwd, $cld, $domain, $year, $infos, $infos_fr) string $resld * : identifiant du revendeur string $cld * : identifiant du client du revendeur string $domain * : nom de domaine dont les infos doivent être modifiées int $year * : durée de réservation du nom de domaine array $infos * string [Nom] nom du propriétaire du nom de domaine string [Prénom] prénom du propriétaire du nom de domaine string [société] société propriétaire du nom de domaine string [Adresse] adresse du propriétaire du nom de domaine string [Zip] code postal du propriétaire du nom de domaine string [Ville] ville du propriétaire du nom de domaine string [Tel] string [Fax] téléphone du propriétaire du nom de domaine fax du propriétaire du nom de domaine string [Mail] string [Pays] du propriétaire du nom de domaine pays du propriétaire du nom de domaine array $infos_fr string [type_depot] type de titulaire ^(particulier societe association marque)$ date [date_naissance] date de naissance ^([0-9]4)\-([0-9]2)\-([0-9]2)$ string [pays_naissance] pays de naissance ^([A-Z]2)$ 8/29

9 string [zip_naissance] code postal de naissance ^([0-9]5)$ string [commune_naissance] commune de naissance ^[0-9a-zA-Z\- ]* int [siren] n siren de la société ^([0-9]9)$ int [insee] n insee de l'association ^([0-9]9)$ int [inpi] n inpi de la marque ^([0-9]9)$ TRUE si la modification de la demande d'enregistrement du nom de domaine a été prise en compte Cette méthode permet de modifier et de relancer la requête de création d'un nom de domaine. Seules les informations relatives à l'enregistrement du nom de domaine sont modifiées, les informations du compte client auquel est rattaché le nom de domaine restent inchangés. Si l'appel du service s'effectue correctement, le nom de domaine est replacé en file d'attente de création, et la requête d'enregistrement du nom de domaine sera renvoyé au prochain passage du cron de création. La variable $infos_fr contient les informations nécessaires lors de l'enregistrement d'un nom de domaine en.fr, elle est donc facultative lors de l'enregistrement d'un nom de domaine d'une extension autre que.fr. function transfer($resld, $resuser, $respwd, $cld, $domain, $year, $infos, $auth_id, $infos_fr) string $resld * : identifiant du revendeur string $cld * : identifiant du client du revendeur string $domain * : nom de domaine dont les infos doivent être modifiées int $year * : durée de prolongation de la validité du nom de domaine suite au transfert array $infos * 9/29

10 string [cld] identifiant du client déjà enregistré si les informations du propriétaire correspondent aux informations de facturation enregistrées lors de la création du compte client si l'identifiant est passé le service va récupérer les informations enregistrées pour cet id si le cld est renseigné les informations suivantes sont inutiles string [Nom] string [Prénom] string [société] string [Adresse] string [Zip] string [Ville] nom du propriétaire du nom de domaine prénom du propriétaire du nom de domaine société propriétaire du nom de domaine adresse du propriétaire du nom de domaine code postal du propriétaire du nom de domaine ville du propriétaire du nom de domaine string [Tel] string [Fax] téléphone du propriétaire du nom de domaine fax du propriétaire du nom de domaine string [Mail] string [Pays] du propriétaire du nom de domaine pays du propriétaire du nom de domaine string $auth_id * : code de transfert ^([a-za-z0-9\-]*)$ array $infos_fr string [type_depot] type de titulaire ^(particulier societe association marque)$ date [date_naissance] date de naissance ^([0-9]4)\-([0-9]2)\-([0-9]2)$ string [pays_naissance] pays de naissance ^([A-Z]2)$ string [zip_naissance] code postal de naissance ^([0-9]5)$ string [commune_naissance] commune de naissance ^([0-9a-zA-Z\- ])* int [siren] n siren de la société ^([0-9]9)$ int [insee] n insee de l'association ^([0-9]9)$ int [inpi] n inpi de la marque ^([0-9]9)$ TRUE si la demande de transfert du nom de domaine a été prise en compte 10/29

11 Cette méthode enregistre une demande de transfert pour le nom de domaine passé en paramètre. Il est possible de passer l'identifiant d'un client déjà enregistré si les informations du propriétaire correspondent aux informations de facturation enregistrées lors de l'enregistrement du compte client, si l'identifiant est passé le service va récupérer les informations enregistrées pour cet id et les utilisent pour le transfert du nom de domaine. La variable $infos_fr contient les informations nécessaires lors du transfert d'un domaine en.fr, elle est donc facultative lors de l'enregistrement d'un nom de domaine possédant une extension autre que.fr. function delete($resid, $resuser, $respwd, $domain) string $domain * : domaine à supprimer boolean[result] TRUE si la demande de suppression du nom de domaine a été prise en compte Cette méthode supprime un domaine du compte d'un client partenaire. Si le nom de domaine est valide, une requête de suppression du nom de domaine est envoyé au registrar correspondant. function renew($resid, $resuser, $respwd, $domain, $year) string $domain * : nom de domaine int $year * : durée en année de la période de renouvellement 11/29

12 TRUE si la demande de renouvellement du nom de domaine a été prise en compte Cette méthode prolonge la période de validité d'un nom de domaine du nombre d'années passé en paramètre. Si l'appel du webservice se déroule avec succès alors la demande de renouvellement/prolongation du nom de domaine est mise en file d'attente et sera traitée lors du prochain passage du cron de renouvellement (dans les 2h). Attention : le renouvellement d'un nom de domaine doit être impérativement effectué au plus tard dans les 15 jours suivant l'expiration du nom de domaine, dans le cas contraire la demande de renouvellement sera rejetée. function get_info($resid, $resuser, $respwd, $domain) NB : Cette méthode est obsolète. Nous vous recommandons l utilisation de la méthode get_info_domain() string $domain * : nom de domaine 12/29

13 [result] string [domain] nom du domaine date [request] date de commande ^[0-9]4\-[0-9]2\-[0-9]2$ date [creation] date de création ^[0-9]4\-[0-9]2\-[0-9]2$ date [expiration] date d'expiration ^[0-9]4\-[0-9]2\-[0-9]2$ string [cid] identifiant du comte client string [type] type de commande ^[creation transfert data_error]$ string [status] status du nom de domaine Cette méthode récupère les informations relatives au nom de domaine passé en paramètre. function get_info_domain($resid, $resuser, $respwd, $domain) string $domain * : nom de domaine [result] string [domain] nom du domaine date [request] date de commande ^[0-9]4\-[0-9]2\-[0-9]2$ date [creation] date de création ^[0-9]4\-[0-9]2\-[0-9]2$ date [expiration] date d'expiration ^[0-9]4\-[0-9]2\-[0-9]2$ string [cid] identifiant du comte client string [type] type de commande ^[creation transfert data_error]$ string [status] status actuel du nom de domaine string [process_msg] dans le cas ou le status n est pas «actif», message concernant la procédure de création ou de transfert. 13/29

14 Cette méthode récupère les informations relatives au nom de domaine passé en paramètre. function get_authid($resid, $resuser, $respwd, $domain) string $domain * : nom de domaine string [result] code d'authorisation saisi lors de la demande de transfert du nom de domaine Cette méthode récupère le code d'authorisation de transfert fourni pour une procédure de transfert entrant en cours. function set_authid($resid, $resuser, $respwd, $domain, $authid) string $domain * : nom de domaine string $auth_id * : code d'authorisation de transfert du nom de domaine ^([a-za-z0-9\-]*)$ 14/29

15 TRUE si la demande de modification du code d'authorisation de transfert du nom de domaine a été prise en compte Cette méthode permet de fournir/changer le code d'authorisation de transfert pour un nom de domaine en cours de transfert entrant, si la modification s'effectue correctement la demande de transfert du nom de domaine est replacée en file d'attente et sera renvoyée lors du prochain passage du cron d'envoi des requêtes de transfert. function unlock($resid, $resuser, $respwd, $domain) string $domain * : nom de domaine string [result] code d'authorisation du nom de domaine Cette méthode débloque un nom de domaine et retourne le code d'authorisation nécessaire au transfert vers un autre prestataire. 15/29

16 function owner_modification($resid, $resuser, $respwd, $cid, $domain, $infos, $infos_fr) string $resld * : identifiant du revendeur string $cld * : identifiant du client du revendeur string $domain * : nom de domaine dont les infos doivent être modifiées array $infos * string [Nom] nom du propriétaire du nom de domaine string [Prénom] prénom du propriétaire du nom de domaine string [société] société propriétaire du nom de domaine string [Adresse] adresse du propriétaire du nom de domaine string [Zip] code postal du propriétaire du nom de domaine string [Ville] ville du propriétaire du nom de domaine string [Tel] string [Fax] téléphone du propriétaire du nom de domaine fax du propriétaire du nom de domaine string [Mail] string [Pays] du propriétaire du nom de domaine pays du propriétaire du nom de domaine array $infos_fr string [type_depot] type de titulaire ^(particulier societe association marque)$ date [date_naissance] date de naissance ^([0-9]4)\-([0-9]2)\-([0-9]2)$ string [pays_naissance] pays de naissance ^([A-Z]2)$ string [zip_naissance] code postal de naissance ^([0-9]5)$ string [commune_naissance] commune de naissance ^[0-9a-zA-Z\- ]* int [siren] n siren de la société ^([0-9]9)$ int [insee] n insee de l'association ^([0-9]9)$ int [inpi] n inpi de la marque ^([0-9]9)$ 16/29

17 TRUE si la modification des informations propriétaire du nom de domaine a été prise en compte Cette méthode permet de modifier les coordonnées du propriétaire du nom de domaine. Seules les informations relatives aux coordonnées propriétaires du nom de domaine sont modifiées, les informations du compte client auquel est rattaché le nom de domaine ne sont pas modifiées. La variable $infos_fr contient les informations nécessaires pour la modification d'un nom de domaine en.fr, elle est donc facultative lors de la modification d'un nom de domaine d'une extension autre que.fr. function customer_modification($resid, $resuser, $respwd, $domain, $cid) string $domain * : nom de domaine string $cid * : identifiant du nouveau compte client TRUE si la demande de modification de compte client du nom de domaine a été prise en compte Cette méthode déplace le nom de domaine d'un compte client partenaire en le rattachant au compte du client partenaire dont l'identifiant de compte est passé en paramètre. 17/29

18 function DNS_modification($resId, $resuser, $respwd, $domain, $dns1, $dns2, $dns3, $dns4) string $domain * : nom de domaine string $dns1 * : nom du 1er serveur DNS string $dns2 * : nom du 2eme serveur DNS string $dns3 : nom du 3eme serveur DNS string $dns4 : nom du 4eme serveur DNS TRUE si la demande de modification des serveurs DNS du nom de domaine a été prise en compte Cette méthode change les serveurs DNS d'un nom de domaine function whois($resid, $resuser, $respwd, $domain) string $domain * : nom de domaine 18/29

19 string [result] whois du nom de domaine. Cette méthode retourne le contenu du whois du nom de domaine passé en paramètre. function free($resid, $resuser, $respwd, $domain) string $domain * : nom de domaine TRUE si le nom de domaine est disponible Cette méthode retourne la disponibilité du nom de domaine passé en paramètre. III. class hosting function add($resid, $resuser, $respwd, $cid, $hosting) string $cid * : identifiant du compte client array $hosting * 19/29

20 string [domain] string [productid] string [year] nom du domaine à héberger identifiant du pack d'hébergement durée de validité de l'hébergement String [FTPlogin] string [FTPpassword] TRUE si la demande de création d'hébergement a bien été prise en compte, FALSE dans le cas contraire. login FTP généré lors de la création de l'hébergement mot de passe FTP générée lors de la création de l'hébergement Cette méthode ajoute un hébergement au compte client d'un partenaire sur le nom de domaine passé en paramètre. Lors de la demande de création de l'hébergement des codes FTP (login et mot de passe) sont générés aléatoirement, les codes ainsi créés sont retournés par le service. function renew($resid, $resuser, $respwd, $cid, $domain, $year) string $cid * : identifiant du compte client string $domain * : nom de domaine hébergé string $year * : durée en année de la période de renouvellement TRUE si le renouvellement de l'hébergement a été effectué Cette méthode prolonge la période de validité d'un hébergement de la durée passée en paramètre. Attention : le renouvellement d'un hébergement doit être impérativement effectué au plus tard dans les 30 jours suivant 20/29

21 l'expiration, dans le cas contraire la demande de renouvellement sera rejetée. function delete($resid, $resuser, $respwd, $cid, $domain) string $cid * : identifiant du compte client string $domain * : nom du domaine hébergé TRUE si l'hébergement a bien été supprimé Cette méthode supprime l'hébergement installé sur le nom de domaine passé en paramètre. Les éventuelles options associées à l'hébergement sont également supprimées. function get_info($resid, $resuser, $respwd, $domain) string $domain * : nom du domaine hébergé 21/29

22 [result] string [FTPlogin] login FTP de l'hébergement string [FTPpassword] mot de passe FTP de l'hébergement string [webipaddress] adresse IP du serveur web string [mailipaddress] adresse IP du serveur mail string [creationdate] date de création de l'hébergement string [expirationdate] date d'expiration de l'hébergement string [PLESKlogin] login d'accès à plesk string [PLESKpassword mot de passe d'accès à plesk Cette méthode retourne les informations relatives à un pack d'hébergement dont le nom de domaine hébergé est passé en paramètre. function upgrade($resid, $resuser, $respwd, $hosting) array $hosting * string [domain] nom du domaine hébergé à upgrader string [productid] identifiant du pack d'hébergement 22/29

23 TRUE si le pack d'hébergement a bien été modifié Cette méthode change le pack d'un hébergement. function customer_modification($resid, $resuser, $respwd, $domain, $cid) string $respwd *: mot de passe du revendeur string $domain * : nom du domaine hébergé string $cid * : identifiant du nouveau compte client TRUE si la demande de modification de compte client de l'hébergement a été prise en compte Cette méthode déplace l'hébergement d'un nom de domaine d'un compte client partenaire en le rattachant au compte du client partenaire dont l'identifiant de compte est passé en paramètre. 23/29

24 IV. class facture function get(...) : récupère une facture (Non implémentée) V. class option function add($resid, $resuser, $respwd, $cid, $opid, $ptype, $pname, $fields_infos) string $cld * : identifiant du client du revendeur int $opid * : id du produit option a ajouter string $ptype * : type de produit auquel l option s applique string $pname * : nom du produit auquel l option s applique array[] $fields_infos string[field_name] : nom du champ d information string[value] : valeur du champ d information ^[domain hosting vps dedicated client]$ int [result] TRUE si l'exécution du webservice s'est déroulée avec succès id de l option ajoutée si la demande d ajout de l option a été prise en compte, 0 dans le cas contraire Cette méthode enregistre une demande d ajout d option pour le produit d un client passé en paramètre. La variable pname contient un nom de domaine si ptype vaut domain ou hosting, le nom d un serveur si ptype vaut vps ou dedicated, et n est pas prise en compte si ptype vaut client. 24/29

25 function renew($resid, $resuser, $respwd, $oid) int $oid * : id de l option a renouveler TRUE si la demande de renouvellement de l option a été prise en compte Cette méthode prolonge la période de validité d'une option. Si l'appel du webservice se déroule avec succès alors la demande de renouvellement/prolongation de l option est mise en file d'attente et sera traitée lors du prochain passage du cron de renouvellement (dans les 2h). function delete($resid, $resuser, $respwd, $oid) int $oid * : id de l option a supprimer boolean[result] TRUE si la demande de suppression de l option a été prise en compte Cette méthode supprime une option d'un client partenaire. function get_info ($resid, $resuser, $respwd, $oid) 25/29

26 int $oid * : id de l option array $infos int $oid : id de l optoin int $opid : id du produit option string $oname : libelle de l option string $ptype : type de produit auquel l option s applique ^[domain hosting vps dedicated client]$ string $pname : nom du produit auquel l option s applique date $creation_date : date de création de l option date $expiration_date : date d expiration de l option array[] $fields_infos string[field_name] : nom du champ d information string[value] : valeur du champ d information Cette méthode retourne les informations relatives à une option créée pour un produit d un client partenaire. VI. class account function get_account($cid, $resid, $respwd) 26/29

27 int [result montant du solce en tocken du compte partenaire Cette méthode retourne le solde de tockens du compte partenaire function get_orders_history(...) Non implémentée function get_actions_history(...) Non implémentée function get_customers($cid, $resid, $respwd) array[] [client] string [nom] nom du compte client string [prenom] prenom du compte client string [societe] societe du compte client string [adresse] adresse du compte client string [zip] code postal du compte client string [ville] ville du compte client string [tel] telephone du compte client 27/29

28 string [fax] fax du compte client string [mail] mail du compte client string [pays] code pays du compte client string [civilite] civilite du compte client string [portable] portable du compte client Cette méthode retourne un tableau contenant les informations de chaque compte client du compte partenaire function get_domains($cid, $resid, $respwd) array[] [domain] string [domain] nom du domaine date [request] date de commande ^[0-9]4\-[0-9]2\-[0-9]2$ date [expiration] date d'expiration ^[0-9]4\-[0-9]2\-[0-9]2$ string [cid] identifiant du comte client Cette méthode retourne un tableau contenant les informations de chaque nom de domaine du compte partenaire. function get_hostings($cid, $resid, $respwd) 28/29

29 array[] [hosting] string [FTPlogin] login FTP de l'hébergement string [FTPpassword] mot de passe FTP de l'hébergement string [webipaddress] adresse IP du serveur web string [mailipaddress] adresse IP du serveur mail string [creationdate] date de création de l'hébergement string [expirationdate] date d'expiration de l'hébergement Cette méthode retourne un tableau contenant les informations de chaque hébergement du compte partenaire. 29/29