documentation

README.md

 # fedmap
 
+## Vocabulaire
 
+  * **type** : un entier associé à un point sur la carte permettant de définir des catégories de points
+  * **ticket** : une chaine de caractères aléatoire unique sans signification servant de preuve. 
+  * **session** : ensemble de requêtes HTTP provenant d'un même utilisateur. L'association entre les différentes requêtes est possible grâce à l'enregistrement d'un identifiant unique (chaine de caractère aléatoire unique sans signification) dans un cookie. 
+  * **email** : chaine de carcatère de la forme nom@domaine 
+  * **latitude**, **longitude** : Décimaux relatifs. Coordonnées géographiques exprimées en degrés d'angle.
+  * **service** : point d'accès au système via le protocole HTTP identifié par un chemin d'URL 
+  * **chemin** : chaine de caractère apparaissant à la fin d'une URL commençant par "/"
+  * **methode** : Verbe du protocole HTTP permettant de qualifier un requête.
+  * **données utilisateur** : données associées à un point de la carte qui ne sont pas utilisées par l'application.
 
-## Configuration apache
+## Fonctionnement
+
+FedMap se compose d'une API HTTP REST.
+
+Les service permettent d'accéder aux données de la carte, d'enregistrer de nouvelles coordonnées,
+d'envoyer un message à une adresse email associée à des coordonnées sur la carte.
+
+L'adresse email constitue un identifiant unique et le système de messagerie constitue le moyen de s'identifier en confirmant son adresse.
+
+## Services
+
+### Approbation d'enregistrement.
+
+Service permetant d'approuver l'enregistrement d'un nouveau point ou d'une modification soumis par un utilisateur. 
+
+  * **chemin** : /approve
+  * **methode** : GET
+  * **données** :
+    * ticket d'approbation passé dans l'URL (/approve:_ticket_)
+  * **retours** :
+
+### Accès aux données utilisateur.
+
+  * **chemin** : /data
+  * **méthode** : GET
+  * **données** : _aucune_
+  * **retours** :
+
+### Accès aux données géographiques.
+
+  * **chemin** : /geojson
+  * **méthode** : GET
+  * **données** :
+    * (facultative) type de point passé dans l'URL (/geojson:_type_) 
+  * **retours** :
+
+### Envoi de message à un contact.
+
+  * **chemin** : /message
+  * **méthode** : POST
+  * **données** :
+  * **retours** :
+
+### Enregistrement d'un emplacement sur la carte ou mise à jour.
+
+  * **chemin** : /record
+  * **méthode** : POST
+  * **données** :
+  * **retours** :
 
-Dans cet exemple de configuration la racine du code est /var/www/fedmap (cd /var/www/fedmap; git clone ...) 
+### Vérification d'ouverture de session.
+
+  * **chemin** : /session
+  * **méthode** : GET
+  * **données** : _aucune_
+  * **retours** :
+
+### Demande d'identification par email
+
+  * **chemin** : /request
+  * **méthode** : POST
+  * **données** :
+  * **retours** :
+
+### Validation d'adresse email
+
+Service permettant de valider une adresse email grâce à un ticket unique envoyé à cette adresse.
+
+  * **chemin** : /validate
+  * **méthode** : GET
+  * **données** :
+    * ticket passé dans l'URL (/validate:_ticket_)
+  * **retours** :
+
+
+### Accès aux données de la carte
+
+
+
+### Page de requête
+
+Avant de
+
+
+## Configuration apache
 
 <VirtualHost *:80>
-	ServerName map
-	DocumentRoot /var/www/fedmap/http
-	Alias /public/ /var/www/
-	AliasMatch ^.*$ /var/www/fedmap/http.php
-	SetEnv CONFIG_PATH /var/www/fedmap/config.php
-	<Directory /var/www/fedmap>
-		Require all granted
-	</Directory>
+	ServerName monsite.fr
+	DocumentRoot /var/www/monsite/
+	AliasMatch ^/fedmap/.*$ /chemin/code/http.php
+	SetEnv CONFIG_PATH /chemin/config/pour/monsite/config.php
 	<IfModule !mod_php7.c>
 		<IfModule proxy_fcgi_module>
 			<IfModule setenvif_module>