Documentation utilisateurs pour le manager v3

Ces documents décrivent l'architecture et le principe de fonctionnement de la partie publique du manager v3.

Manager V3 Principes Generaux

Le résultat est la possibilité pour chacun d'integrer des espaces de gestion du site directement au sein de celui ci, ou de revendre des hébergements OVH dans le cas des revendeurs.

Technologies mises en oeuvre:

Les fonctions mises à disposition par OVH sont accessible à distance par le biais d'un mécanisme d'appel de procedure à distance appellé RPC (Remote Procedure Call),

Les appels ont donc lieu à travers SOAP, cousin du XMLRPC.

Qu'est ce que SOAP

SOAP est un protocole permettant de travailler en RPC (Remote procedure call). Le principe de fonctionnement se base sur l'encodage des données des appels de fonctions en XML. Les appels de fonctions sont issues d'un ordinateur distant qui se connecte sur le serveur de fonction, lui indique quelle fonction il veut appeler avec quels paramètres. Le serveur de fonction execute la fonction et retourne ensuite par le réseau le résultat (ou les erreurs eventuelles).

L'avantage de cette encapsulation dans une structure XML est qu'elle permet à des ordinateurs utilisant des systèmes différents et à des programmes écrits dans des langages différents de fonctionner ensemble: c'est le concept d'interopérabilité.



Le manager V3 se base sur SOAP::Lite, un CPAN Perl

Comment utiliser l'API OVH ?

Pour acceder à notre ensemble de fonctions, vous pouvez utiliser le language de votre choix (et sur la plateforme de votre choix). Que vous vouliez programmer en Perl, en PHP, en C++, il vous suffit d'avoir a votre disposition une bibliotheque de fonctions pour SOAP?



Vous pouvez consulter une liste d'implémentations disponibles ici:

http://www.soapware.org/directory/4/implementations



Cette liste n'est pas exhaustive.

Liste des fonctions, Gestion des erreurs et autres festivités

La liste complete des fonctions triées par catégorie se trouve ici: http://www.ovh.com/fr/managers/docpublic.xml

Pour l'instant ce site animé par un developpeur : http://www.verot.org/ovhapi/ est plus à jour

Schéma d'une session d'utilisation des fonctions d'ovh:

Création d'une session

Appels des fonctions désirées

Fermeture de la session

Exploiter les fonctions du manager v3 pour construire son propre manager

Principes generaux de l'api

ManagerV3AppellerDesFonctions

ManagerV3GestionEmails

D'autres guides arriveront bientot

Quelques exemples d'exploitation de notre api

http://hebergement.cibaxion.com

http://merlet.info/

Contributions

Merci à Nicolas Merlet pour son api

et à Colin Verot pour sa page avec la documentation