Le service Web
- Description du service
- Exemples d'utilisation
- Exemple de réponse
- Méthode : wgGetLastWall
- Méthode : wgSearchForum
- Méthode : wgSearchMlist
- Méthode : wgSearchFaq
- Méthode : wgGetWaitingFile
- Méthode : wgGetWaitingFaq
- Méthode : wgGetListMember
- Méthode : wgGetListAdmin
- Méthode : wgGetUserInfos
Description
Le service web du phpworkgroup permet d'interroger le site à distance grâce à
un serveur SOAP et à de nombreuses
méthodes mises à disposition.
L'interrogation du service peut se faire de différentes manières :
- En utilisant l'extension SOAP de php5.
- Avec des librairies type nusoap ou
pear SOAP.
- Avec une requête HTTP (type REST) ou CURL.
Dans la majorité des cas, le service retournera une réponse au format SOAP.
Exemples d'utilisation :
- Avec PHP5 SOAP
<?php
$wsdl = 'http://phpworkgroup.org/webservice/Webservices.wsdl';
$options = array('trace' => 1,'soap_version' => SOAP_1_1);
$client = new SoapClient($wsdl, $options);
$client -> wgGetLastWall(2);
header('Content-Type:text/xml');
echo $client -> __getLastResponse();
?>
- Avec requête HTTP :
http://phpworkgroup.org/webservice/service.php?method=methodName¶m=value
- Avec CURL :
<?php
// Paramètres :
$params['method'] = 'wgGetLastWall';
$params['limit'] = 2;
// Appel :
$cUrl = curl_init('http://phpworkgroup.org/webservice/service.php');
curl_setopt($cUrl, CURLOPT_POST, TRUE);
curl_setopt($cUrl, CURLOPT_POSTFIELDS, $params);
curl_setopt($cUrl, CURLOPT_TIMEOUT, 50);
curl_setopt($cUrl, CURLOPT_CONNECTTIMEOUT, 50);
curl_setopt($cUrl, CURLOPT_FOLLOWLOCATION, TRUE);
curl_setopt($cUrl, CURLOPT_HEADER, false);
curl_setopt($cUrl, CURLOPT_RETURNTRANSFER, TRUE);
$response = curl_exec($cUrl);
// Affichage :
header('Content-Type:text/xml');
echo $response;
?>
Exemple de réponse :
<SOAP-ENV:Envelope> <SOAP-ENV:Body> <SOAP-ENV:wgGetLastWallResponse> <return> <ns1:wallElement> <id>3</id> <date>2006-02-10 10:10:49</date> <name>visiteur</name> <desc>test php</desc> <url>http://phpworkgroup.org/wall-3.html#wall</url> </ns1:wallElement> </return> </SOAP-ENV:wgGetLastWallResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Requêtes et réponses
- wgGetLastWall
Permet de récuperer la liste des derniers walls.
- Méthode :
- wgGetLastWall
- paramètre(s) :
- limit : le nombre de walls à retourner
- Réponse :
- id : Id du wall
- name : Nom du posteur
- desc : Description
- date : Date du post
- url : Url du wall
- Exemple d'appel :
- http://phpworkgroup.org/webservice/service.php?method=wgGetLastWall&limit=1
- wgSearchForum
Recherche dans le forum.
- Méthode :
- wgSearchForum
- paramètre(s) :
- keyword : le mot à rechercher
- Réponse :
- id : Id du post
- name : Nom du posteur
- titre : Titre du post
- date : Date dernière réponse
- url : Url du post
- Exemple d'appel :
- http://phpworkgroup.org/webservice/service.php?method=wgSearchForum&keyword=php
- wgSearchMlist
Recherche dans les archives de la liste de discussion.
- Méthode :
- wgSearchMlist
- paramètre(s) :
- keyword : le mot à rechercher
- Réponse :
- id : Id du mail
- sujet : Sujet du mail
- date : Date d'envoi
- getAdress : Adresse de récupération du mail
- url : Url de consultation du mail
- Exemple d'appel :
- http://phpworkgroup.org/webservice/service.php?method=wgSearchMlist&keyword=php
- wgSearchFaq
Recherche dans les archives de la FAQ.
- Méthode :
- wgSearchFaq
- paramètre(s) :
- keyword : le mot à rechercher
- Réponse :
- cat : Catégorie FAQ
- question : La question
- reponse : La réponse
- url : Url de la question.
- Exemple d'appel :
- http://phpworkgroup.org/webservice/service.php?method=wgSearchFaq&keyword=php
- wgGetWaitingFile
Liste des fichiers en attente de validation.
- Méthode :
- wgGetWaitingFile
- paramètre(s) :
- Aucun
- Réponse :
- id : id du fichier
- directory : Répertoire
- file : Fichier
- name : Pseudo du membre ayant proposé
- url : Url de consultation du fichier
- Exemple d'appel :
- http://phpworkgroup.org/webservice/service.php?method=wgGetWaitingFile
- wgGetWaitingFaq
Liste des questions en attente de validation.
- Méthode :
- wgGetWaitingFaq
- paramètre(s) :
- Aucun
- Réponse :
- id : id du fichier
- question : Question proposée
- reponse : Réponse proposée
- Exemple d'appel :
- http://phpworkgroup.org/webservice/service.php?method=wgGetWaitingFaq
- wgGetListMember
Liste des membres du phpworkgroup.
- Méthode :
- wgGetListMember
- paramètre(s) :
- Aucun
- Réponse :
- id : id du user
- pseudo : Pseudo du user
- inscription : Date d'inscription
- email : Email du user
- level : Niveau
- Exemple d'appel :
- http://phpworkgroup.org/webservice/service.php?method=wgGetListMember
- wgGetListAdmin
Liste des administrateurs du phpworkgroup.
- Méthode :
- wgGetListAdmin
- paramètre(s) :
- Aucun
- Réponse :
- id : id du user
- pseudo : Pseudo du user
- inscription : Date d'inscription
- email : Email du user
- level : Niveau
- Exemple d'appel :
- http://phpworkgroup.org/webservice/service.php?method=wgGetListAdmin
- wgGetUserInfos
Informations sur un utilisateur.
- Méthode :
- wgGetUserInfos
- paramètre(s) :
- name : pseudo de l'utilisateur.
- Réponse :
- id : id du user
- pseudo : Pseudo du user
- inscription : Date d'inscription
- email : Email du user
- prenom : Le prénom
- nom : Le nom
- naissance : La date
- description : A quoi ça ressemble
- msn : Adresse MSN
- jabber
- aim
- icq
- avatar : url de l'avatar
- job : Occupation
- localisation : habitat
- Exemple d'appel :
- http://phpworkgroup.org/webservice/service.php?method=wgGetUserInfos&name=mcAllan