Creation fichier readme API serveur Loquicompta

readme.md

@@ -0,0 +1,151 @@
+
+
+Spécification de l'API d'un serveur Loquicompta
+
+# Réponse en cas d'erreur
+
+Lors de l'utilisation de l'api si la requete est invalide le retour est de la forme suivante
+
+```json
+{
+    success: false,
+    code: int,
+    message: "string"
+}
+```
+
+Les codes d'erreurs sont les suivants :
+
+- 01 : Requete invalide
+- 02 : Authentification incorrect
+- 03 : Token incorrect
+- 04 : Token expiré
+
+# Points d'éntrées 
+
+`GET /authorization`
+
+Indique si le serveur necessite un mot de passe pour accèder aux fichiers
+
+```json
+// Reponse
+{
+    success: true,
+    authorization: boolean
+}
+```
+
+------
+
+`POST /login`
+
+Connexion de l'utilisateur et retourne un jeton de connexion. Le jeton de connexion est valide 12h00 après son émission.
+
+```json
+// Requete
+{
+    user: "string",
+    password: "string"
+}
+// Reponse
+{
+    success: true,
+    token: "string"
+}
+```
+
+------
+
+`POST /token/{token}`
+
+Permet de tester la validitée d'un jeton émit lors de la connexion
+
+```json
+// Requete
+{
+    user: "string" // Username
+    token: "string"
+}
+// Reponse
+{
+    success: true,
+    valid: boolean
+}
+```
+
+
+
+------
+
+`POST /list/{token}`
+
+Liste les fichiers disponible pour l'utilisateur. La valeur token n'est necessaire que si l'authentification est activée.
+
+```json
+// Requete
+{
+    user: "string" // Username
+    token: "string"
+}
+// Reponse
+{
+    success: true,
+    list: ["fileId1", "fileId2", ...]
+}
+```
+
+------
+
+`POST /get/{file}`
+
+Récupère un fichier. Remplacer {file} par l'id du fichier à récupèrer. La valeur token n'est necessaire que si l'authentification est activée.
+
+```json
+// Requete
+{
+    user: "string" // Username
+    token: "string"
+}
+// Reponse
+{
+    success: true,
+    fileid: "string",
+    filename: "string",
+    data: "string"
+}
+```
+
+------
+
+`POST /save/{file}/{token}`
+
+Sauvegarde un fichier. Remplacer {file} par l'id du fichier à récupèrer. La valeur token n'est necessaire que si l'authentification est activée.
+
+```json
+// Requete
+{
+    user: "string" // Username
+    token: "string"
+    data: "string" // File content
+}
+// Reponse
+{
+    success: true,
+    fileid: "string",
+    filename: "string"
+}
+```
+
+------
+
+`GET /logout/{token}`
+
+Déconnecte l'utilisateur. Remplacer {token} par le jeton de connexion à invalider
+
+```json
+// Reponse
+{
+    success: true
+}
+```
+