Changes between Initial Version and Version 1 of ApiAppelOffre

Timestamp:

Sep 20, 2018, 10:04:01 AM (7 years ago)

Author:

x.pechoultres@clariprint.com

Comment:

--

ApiAppelOffre

@@ +1 @@
+= API d'Appel d'offre de Clariprint =
+
+
+L'API d'Appel d'Offre permet de lancer des calculs en lots.
+
+== API CSV ==
+
+L'api CSV est adaptée pour des données provenant d'un tableur (Excel).
+
+=== Base ===
+ * Type de requête : POST
+ * url : mon_domaine/optimprokect/csv.wcl
+
+=== Création d'un appel d'offre ===
+Données du formulaire :
+ * '''key''' : clef API define au niveau du Client Optimproject
+ * '''action''' => "creation" 
+ * '''callback''' : URL appelée par le système à la fin du calcul (à tester)
+ * '''sheets''' : tableau de nom de feuille. ex : sheets[]="A"&sheets[]="B")
+ * '''columns''' : tableau des colonne indexé sur les feuilles. ex : columns[A]="projet;code;hauteur;largeur;"
+ * '''rows''' : tableau indexe des ligne de calcul (les projet à calculer)
+  * la clef d'index contient "<nom de la feuille>!<num de ligne>" : le nom de la feuille doit correspondre à une feuille de '''sheets''', le num de ligne doit juste permette une clef unique. sous un tableur on utilise le numéro de la ligne
+  * valeurs : sous la forme d'une liste séparée par un ";" qui doit correspondre au colonnes (columns) définies.
+
+==== Données retournées ====
+Données retournées en mode CSV.
+
+Une ligne retournant la clef de session 
+{{{
+SESSION;<clef de session>
+}}}
+
+Pour chaque projet identifié, retourne une ligne
+{{{
+PROJECT;-;<nom du projet>;CREATE
+}}}
+
+
+=== Demande de résultats ===
+Données du formulaire :
+ * '''key''' : clef API define au niveau du Client Optimproject
+ * '''session''' : le code session
+ * '''action''''  :"status"
+
+Données retournées :
+
+Pour chaque projet, une ligne de type :
+{{{
+PROJET;<id clariprint>;<reference>;<OK | CALCUL>;<meilleur tarif>;<mille plus>;<nom du fournisseur>
+}}}
+
+Si en mode CALCUL, les autres données sont vides.
+
+
+
+== Structures des colonnes ==
+