SP:Part:API
De Hegyd Doc.
(Différences entre les versions)
(→API de Viaduc) |
(→WSDL) |
||
| (2 versions intermédiaires masquées) | |||
| Ligne 11 : | Ligne 11 : | ||
=== Fichiers === | === Fichiers === | ||
| - | * api- | + | * ''api-monitor.php'': fichier permettant de vérifier si le service est opérationnel |
| - | * server.php: serveur SOAP | + | * ''server.php'': serveur SOAP |
| - | * test.php: fichier de test permetttant de savoir si l'API VIADUC est opérationnelle | + | * ''test.php'': fichier de test permetttant de savoir si l'API VIADUC est opérationnelle |
| - | * wsdl.php: appelé lors de la demande d'affichage du shéma wsdl des fonctions disponibles | + | * ''wsdl.php'': appelé lors de la demande d'affichage du shéma wsdl des fonctions disponibles |
| - | + | ||
===Classes === | ===Classes === | ||
| Ligne 24 : | Ligne 23 : | ||
== WSDL == | == WSDL == | ||
| - | Le fichier WSDL est généré automatiquement en fonction des commentaires | + | Le fichier WSDL est généré automatiquement en fonction des commentaires associés aux fonctions de l'API. |
== API de Viaduc == | == API de Viaduc == | ||
| Ligne 30 : | Ligne 29 : | ||
La classe '''RPCViaduc''' permet de se connecter et de créer un client de l'API VIADUC. | La classe '''RPCViaduc''' permet de se connecter et de créer un client de l'API VIADUC. | ||
| - | La variable API_VIADUC de la [[SP: | + | La variable API_VIADUC de la [[SP:Configuration_Générale|configuration]] renseigne l'URl du WSDL de l'API VIADUC. |
Version actuelle en date du 7 juillet 2010 à 07:21
Sommaire |
[modifier] L'API des sites packagés
L'api se base sur SOAP. Elle estutilisé par l'application tierce VIADUC.
[modifier] Fonctionnement
[modifier] Fichiers
- api-monitor.php: fichier permettant de vérifier si le service est opérationnel
- server.php: serveur SOAP
- test.php: fichier de test permetttant de savoir si l'API VIADUC est opérationnelle
- wsdl.php: appelé lors de la demande d'affichage du shéma wsdl des fonctions disponibles
[modifier] Classes
La classe models/WebService.php contient toutes les méthodes de l'API. La classe models/APIServer.php contient les méthodes permettant l'authentification au serveur.
[modifier] WSDL
Le fichier WSDL est généré automatiquement en fonction des commentaires associés aux fonctions de l'API.
[modifier] API de Viaduc
La classe RPCViaduc permet de se connecter et de créer un client de l'API VIADUC.
La variable API_VIADUC de la configuration renseigne l'URl du WSDL de l'API VIADUC.
