trunk/services/README.txt

/**
 * Ce fichier permet de décrire l'utilisation des webservices pour l'application
 * openFoncier.
 *
 * @package openfoncier
 * @version SVN : $Id$
 * 
 */

#############
Services REST
#############

********************************************
Configuration d'Apache pour utiliser RESTLER
********************************************

Activer le mod_rewrite Apache
=============================

Le module Apache mod_rewrite est un module qui permet la réécriture des URLs.
Pour utiliser RESTLER il faut que ce module soit activé. Pour ce faire ::

    $ a2enmod rewrite


Paramétrer le virtualhost
=========================

Ajouter les lignes suivantes dans le paramétrage du virtualhost souhaité ::

    RewriteEngine On
        RewriteCond %{REQUEST_URI} ^.*/openfoncier/services/(.*[^/])
    RewriteRule ^(.*)$ /var/www/openfoncier/services/rest_entry.php [QSA,L]

Dans la configuration de votre virtualhost penser à ce que les méthodes HTTP
nécessaires GET, PUT, POST, DELETE soient autorisées.


Redémarrer Apache
=================

Pour que les changements prennent effet il faut redémarrer le serveur Apache ::

    $ /etc/init.d/apache2 restart


************************************************************
Utilisation des services REST avec curl en ligne de commande
************************************************************

Pour envoyer une demande concernant les utilisateurs, avec curl et simple HTTP authetification, on fait :

- en cas de GET :
$ curl --user <username> -v http://<server>/<path_to>/services/utilisateurs/<ID>

Le '<ID>' doit etre remplace par l'ID d'un utilisateur, le '<server>' doit etre remplace par un server IP
ou un domain name, et '<path_to>' est le chemin, dans la hierarchie des fichiers, ou se trouve openfoncier. 

- en cas de POST :
curl --user <username> -v -H "Content-Type: application/json" -d '{"nom":"Thierry", "email":"[email protected]","login":"tehierry","pwd":"password","om_profil":"5","om_collectivite":"1","om_type":"db_type"}' -X POST  http://<server>/<path_to>/services/utilisateurs

- en cas de PUT:
$ curl --user <username> -v -H "Content-Type: application/json" -d '{"nom":"Changed_name"}' -X PUT  http://<server>/<path_to>/services/utilisateurs/<ID>

- en cas de DELETE:
$ curl --user <username> -v -X DELETE http://localhost/~mirna/head_openfoncier/services/utilisateurs/<ID>

En cas d'encryptage SSL des donnes, curl doit etre utilise avec l'option E comme par exemple :
$ curl -E /<path_to>/key_certificate.concat --cacert /<path_to>/self_signed_sertificate.crt -k -v -H --user <username> -v https://<server>/<path_to>/services/utilisateurs/<ID>

Le key_certificate.concat contient la cle avec le certificat colle a la fin de la cle.


*****************************************
Description des services REST openFoncier
*****************************************

Ressource 'maintenance'
=======================

Méthode POST
------------

/services/maintenance

{
"module" : "user",
"data" : "NA"
}


{
"module" : "consultation",
"data" : "NA"
}


Ressource 'consultations'
=========================

Méthode PUT
-----------


Ressource 'messages'
====================

Méthode POST
------------


Ressource 'dossier_autorisation'
================================

Méthode PUT
-----------


Méthode GET
-----------


1	fmichon	753	/**
2			* Ce fichier permet de décrire l'utilisation des webservices pour l'application
3			* openFoncier.
4			*
5			* @package openfoncier
6			* @version SVN : $Id$
7			*
8			*/
9	mlimic	515
10	fmichon	753	#############
11			Services REST
12			#############
13	mlimic	515
14	fmichon	753	********************************************
15			Configuration d'Apache pour utiliser RESTLER
16			********************************************
17	mlimic	515
18	fmichon	753	Activer le mod_rewrite Apache
19			=============================
20	mlimic	515
21	fmichon	753	Le module Apache mod_rewrite est un module qui permet la réécriture des URLs.
22			Pour utiliser RESTLER il faut que ce module soit activé. Pour ce faire ::
23	mlimic	515
24	fmichon	753	$ a2enmod rewrite
25	mlimic	515
26	fmichon	753
27			Paramétrer le virtualhost
28			=========================
29
30			Ajouter les lignes suivantes dans le paramétrage du virtualhost souhaité ::
31
32	mlimic	541	RewriteEngine On
33	fmichon	753	RewriteCond %{REQUEST_URI} ^./openfoncier/services/(.[^/])
34			RewriteRule ^(.*)$ /var/www/openfoncier/services/rest_entry.php [QSA,L]
35	mlimic	515
36	fmichon	753	Dans la configuration de votre virtualhost penser à ce que les méthodes HTTP
37			nécessaires GET, PUT, POST, DELETE soient autorisées.
38	mlimic	515
39
40	fmichon	753	Redémarrer Apache
41			=================
42	mlimic	515
43	fmichon	753	Pour que les changements prennent effet il faut redémarrer le serveur Apache ::
44	mlimic	515
45	fmichon	753	$ /etc/init.d/apache2 restart
46	mlimic	515
47
48
49	fmichon	753	************************************************************
50			Utilisation des services REST avec curl en ligne de commande
51			************************************************************
52
53	mlimic	522	Pour envoyer une demande concernant les utilisateurs, avec curl et simple HTTP authetification, on fait :
54	mlimic	515
55	mlimic	522	- en cas de GET :
56			$ curl --user <username> -v http://<server>/<path_to>/services/utilisateurs/<ID>
57	mlimic	515
58	mlimic	522	Le '<ID>' doit etre remplace par l'ID d'un utilisateur, le '<server>' doit etre remplace par un server IP
59			ou un domain name, et '<path_to>' est le chemin, dans la hierarchie des fichiers, ou se trouve openfoncier.
60	mlimic	515
61	mlimic	522	- en cas de POST :
62			curl --user <username> -v -H "Content-Type: application/json" -d '{"nom":"Thierry", "email":"[email protected]","login":"tehierry","pwd":"password","om_profil":"5","om_collectivite":"1","om_type":"db_type"}' -X POST http://<server>/<path_to>/services/utilisateurs
63	mlimic	515
64	mlimic	522	- en cas de PUT:
65			$ curl --user <username> -v -H "Content-Type: application/json" -d '{"nom":"Changed_name"}' -X PUT http://<server>/<path_to>/services/utilisateurs/<ID>
66	mlimic	515
67	mlimic	522	- en cas de DELETE:
68			$ curl --user <username> -v -X DELETE http://localhost/~mirna/head_openfoncier/services/utilisateurs/<ID>
69	mlimic	515
70	mlimic	522	En cas d'encryptage SSL des donnes, curl doit etre utilise avec l'option E comme par exemple :
71			$ curl -E /<path_to>/key_certificate.concat --cacert /<path_to>/self_signed_sertificate.crt -k -v -H --user <username> -v https://<server>/<path_to>/services/utilisateurs/<ID>
72	mlimic	515
73	mlimic	522	Le key_certificate.concat contient la cle avec le certificat colle a la fin de la cle.
74	fmichon	753
75
76
77			*****************************************
78			Description des services REST openFoncier
79			*****************************************
80
81			Ressource 'maintenance'
82			=======================
83
84			Méthode POST
85			------------
86
87			/services/maintenance
88
89			{
90			"module" : "user",
91			"data" : "NA"
92			}
93
94
95			{
96			"module" : "consultation",
97			"data" : "NA"
98			}
99
100
101
102			Ressource 'consultations'
103			=========================
104
105			Méthode PUT
106			-----------
107
108
109
110			Ressource 'messages'
111			====================
112
113			Méthode POST
114			------------
115
116
117
118			Ressource 'dossier_autorisation'
119			================================
120
121			Méthode PUT
122			-----------
123
124
125			Méthode GET
126			-----------
127
128