Notice API NeoBe

Transcription

1 Notice API NeoBe DROPCLOUD S.A.S. 11 Avenue du Val de Fontenany, FONTENAY SOUS BOIS

2 Index SERVEUR SOAP NEOBE... 3 PARAMETRES D APPEL... 3 FONCTIONNALITES DE L'API... 3 GETSPACEAPI... 3 GETUSEDSPACEAPI... 3 GETNBFILESAPI... 3 GETNBFILESMAXAPI... 4 GETPASSWORDAPI... 4 GETCOMMENTAPI... 4 GETACCOUNTOWNERAPI... 4 GETLOGINAPI... 4 GETPACKAPI... 5 GETEXPAPI... 5 GETEXPFAPI... 5 ISMULTIAPI... 5 GETIDMACHINEAPI... 5 ISUNLOCKERAPI... 6 ISLOCALAPI... 6 ISDDAPI... 6 GETETATAPI... 6 GETLASTSAVINGAPI... 6 GETALLSPACEAPI... 7 GETALLUSEDSPACEAPI... 7 SETSPACEAPI... 7 SETPASSWORDAPI... 7 SETCOMMENTAPI... 7 SETACCOUNTOWNERAPI... 8 SETPACKAPI... 8 SETDATEAPI... 8 SETDATEFAPI... 8 SETMULTIAPI... 8 SETUNLOCKERAPI... 9 SETLOCALAPI... 9 SETDDAPI... 9 SETETATAPI... 9 DELETEIDMACHINEAPI CLEANACCOUNTAPI DELETEACCOUNTAPI ADDACCOUNTAPI GETLISTACCOUNTAPI GETDELAYOFLASTACTIVITYAPI

3 SERVEUR SOAP NEOBE Paramètres d appel Appel du serveur SOAP : Appel du WSDL : L'appel se fait obligatoirement en HTTPS. Le paramètre «key» est indispensable lors des appels. Il permet d'identifier le client qui se connecte à l'api. Si la clé n'est pas valide, l'appel au serveur soap échoue. FONCTIONNALITES DE L'API getspaceapi return (string) : retourne l'espace alloué du compte. «error» en cas de problème. getusedspaceapi return (string) : retourne l'espace utilisé en temps réel du compte. «error» en cas de problème. getnbfilesapi return (int) : retourne le nombre de fichiers sur le compte. «error» en cas de problème. 3

4 getnbfilesmaxapi return (int) : retourne le nombre maximum de fichiers autorisés sur le compte. «error» en cas de problème. getpasswordapi return (string) : retourne le mot de passe du compte. «error» en cas de problème. getcommentapi return (string) : retourne les commentaires du compte. «error» en cas de problème. getaccountownerapi return (string) : retourne le bénéficiaire du compte. «error» en cas de problème. getloginapi return (string) : retourne le login du compte. «error» en cas de problème. 4

5 getpackapi return (string) : retourne l'intitulé du pack du compte. «error» en cas de problème. getexpapi return (date) : retourne la date d'expiration du compte (YYY-MM-DD). « » en cas de problème. getexpfapi return (date) : retourne la date d'expiration fictive du compte (YYY-MM-DD). « » en cas de problème. ismultiapi return (string) : permet de savoir si l'option de multi-compte est activée sur le compte (true / false). «error» en cas de problème. getidmachineapi return (string) : retourne l'identifiant machine d'un compte. «error» en cas de problème. 5

6 isunlockerapi return (string) : permet de savoir si l'option de sauvegarde des fichiers ouverts est activée sur le compte (true / false). «error» en cas de problème. islocalapi return (string) : permet de savoir si l'option de sauvegarde locale est activée sur le compte (true / false). «error» en cas de problème. isddapi return (string) : permet de savoir si l'option de disque dur en ligne est activée sur le compte (true / false). «error» en cas de problème. getetatapi return (string) : retourne l'état du compte (Actif, Désactivé, Effacé, Effacement programmé). «error» en cas de problème. getlastsavingapi 6

7 return (string) : retourne les dernières sauvegardes faites sur le compte. Chaque sauvegarde est séparée par «\n». «error» en cas de problème. Retourne «no_task» si aucune sauvegarde n'a été trouvée. getallspaceapi return (string) : retourne la somme des espace alloués de vos comptes. «error» en cas de problème. getallusedspaceapi return (string) : retourne la somme des espace utilisés en temps réel de vos comptes. «error» en cas de problème. setspaceapi space (int) : taille en Go return (boolean) : retourne «true» si l'espace a été mis à jour. «false» en cas de problème. setpasswordapi password (string) : nouveau mot de passe return (boolean) : retourne «true» si le mot de passe a été mis à jour. «false» en cas de problème. setcommentapi comment (string) : nouveau commentaire du compte return (boolean) : retourne «true» si le commentaire a été mis à jour. «false» en cas de problème. 7

8 setaccountownerapi beneficiaire (string) : nouveau bénéficiaire du compte return (boolean) : retourne «true» si le bénéficiaire a été mis à jour. «false» en cas de problème. setpackapi pack (int) : nouveau pack du compte (3 = Premium, 9 = Platinum) return (boolean) : retourne «true» si le pack a été mis à jour. «false» en cas de problème. setdateapi date (date) : nouvelle date d'expiration (YYY-MM-DD) return (boolean) : retourne «true» si la date d'expiration a été mise à jour. «false» en cas de problème. setdatefapi date (date) : nouvelle date d'expiration fictive (YYY-MM-DD) return (boolean) : retourne «true» si la date d'expiration fictive a été mise à jour. «false» en cas de problème. setmultiapi flag (boolean) : active ou non l'option multi-compte pour le compte 8

9 return (boolean) : retourne «true» si l'option multi-compte a été mise à jour. «false» en cas de problème. setunlockerapi flag (boolean) : active ou non l'option de sauvegarde des fichiers ouverts pour le compte return (boolean) : retourne «true» si l'option de sauvegarde des fichiers ouverts a été mise à jour. «false» en cas de problème. setlocalapi flag (boolean) : active ou non l'option de sauvegarde locale pour le compte return (boolean) : retourne «true» si l'option de sauvegarde locale a été mise à jour. «false» en cas de problème. setddapi flag (boolean) : active ou non l'option de disque dur en ligne pour le compte return (boolean) : retourne «true» si l'option de disque dur en ligne a été mise à jour. «false» en cas de problème. setetatapi etat (string) : nouvel état du compte (AC = Actif, DE = Désactivé, EP = Effacement programmé) return (boolean) : retourne «true» si l'état a été mis à jour. «false» en cas de problème. 9

10 deleteidmachineapi return (boolean) : retourne «true» si l'identifiant de la machine du compte a été supprimé. «false» en cas de problème. cleanaccountapi return (boolean) : retourne «true» si le compte a été vidé. «false» en cas de problème. deleteaccountapi return (boolean) : retourne «true» si le compte a été supprimé. «false» en cas de problème. addaccountapi space (int) : taille du compte en Go recipient (string) : bénéficiaire du compte password (string) : mot de passe du compte expiration (date) : date d'expiration du compte (YYYY-MM-DD) unlocker (boolean) : active ou non l'option de sauvegarde des fichiers ouverts local (boolean) : active ou non l'option de sauvegarde locale dd (boolean) : active ou non l'option de disque dur en ligne return (string) : retourne le numéro du compte si le compte a été créé. «error» en cas de problème, «full» s'il n'y a plus de place sur le compte père. getlistaccountapi 10

11 return (array) : retourne un tableau avec tout les comptes actifs créés. «error» en cas de problème. getdelayoflastactivityapi return (string) : retourne le nombre de jours depuis la dernière activité du compte. «error» en cas de problème. Retourne «no_task» si aucune sauvegarde n'a été trouvée. 11

12 Info Démo - Devis L équipe NeoBe - DropCloud se tient à votre disposition. neobe.fr Lun Ven 9h30 18h DROPCLOUD 11 AVENUE DU VAL DE FONTENAY FONTENAY SOUS BOIS Téléphone : info@neobe.fr Version Juin