Documentation Veostack

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision
Révision précédente
api [2019/05/09 00:19]
rsiveo
api [2021/08/23 14:18] (Version actuelle)
rsiveo
Ligne 1: Ligne 1:
-**Accès à l'API**+<title>Documentation API Recouveo v19.02 (simplifié)</title>
  
 === Format général === === Format général ===
-<code>POST https://<server-node>/API/<method-code></code>+<code>POST https://<server-url>/API/<method-code></code>
   * les données sont transmises par tableau d'objets, encodé au format JSON   * les données sont transmises par tableau d'objets, encodé au format JSON
-  * les paramètres d'accès (code domaine, token) sont fournis par authentification HTTPS+  * les paramètres d'accès (code domaine, token) sont transmis par authentification HTTPS
 Exemple authentification HTTPS Exemple authentification HTTPS
 <code>USER : prod@veo <code>USER : prod@veo
-PASS : xxxxxxxxxxxxxxx</code>+PASS : <token></code> 
 +Note : les informations d'accès (code domaine + token) seront fournies par RecouveoSI à la création du compte
  
 === Intégration de comptes acheteurs - Méthode ACCOUNT === === Intégration de comptes acheteurs - Méthode ACCOUNT ===
  
-<code>POST https://<server-node>/API/account</code>+<code>POST https://<server-url>/API/account</code>
  
 JSON Object keys : JSON Object keys :
Ligne 22: Ligne 23:
 <code> <code>
 [{ [{
-  "IdSoc": "FC",+  "IdSoc": "VEO",
   "IdCli": "1234567890",   "IdCli": "1234567890",
-  "NameCli": "Alain MARTIN"+  "NameCli": "Alain MARTIN", 
 +  "Meta:PAYS": "BE", 
 +  "Meta:DIVISION": "005"
 },{ },{
-  "IdSoc": "FC",+  "IdSoc": "VEO",
   "IdCli": "9876543210",   "IdCli": "9876543210",
-  "NameCli": "Martine DURAND"+  "NameCli": "Martine DURAND", 
 +  "Meta:PAYS": "FR", 
 +  "Meta:DIVISION": "101"
 }] }]
 </code> </code>
Ligne 34: Ligne 39:
 === Intégration de comptes acheteurs - Méthode ACCOUNT_ADRBOOKENTRY === === Intégration de comptes acheteurs - Méthode ACCOUNT_ADRBOOKENTRY ===
  
-<code>POST https://<server-node>/API/account_adrbookentry</code>+<code>POST https://<server-url>/API/account_adrbookentry</code>
  
 JSON Object keys : JSON Object keys :
Ligne 46: Ligne 51:
 <code> <code>
 [{ [{
-  "IdSoc": "FC",+  "IdSoc": "VEO",
   "IdCli": "9876543210",   "IdCli": "9876543210",
   "AdrType": "POSTAL",   "AdrType": "POSTAL",
-  "Adr": "1 rue de la Plumerette 94000 Créteil"+  "Adr": "1 rue de la Plumerette\n94000 Créteil"
 },{ },{
-  "IdSoc": "FC",+  "IdSoc": "VEO",
   "IdCli": "9876543210",   "IdCli": "9876543210",
   "AdrType": "TEL",   "AdrType": "TEL",
   "Adr": "0600000000"   "Adr": "0600000000"
 },{ },{
-  "IdSoc": "FC",+  "IdSoc": "VEO",
   "IdCli": "9876543210",   "IdCli": "9876543210",
   "AdrType": "EMAIL",   "AdrType": "EMAIL",
Ligne 67: Ligne 72:
 === Intégration de comptes acheteurs - Méthode RECORD === === Intégration de comptes acheteurs - Méthode RECORD ===
  
-<code>POST https://<server-node>/API/record</code>+<code>POST https://<server-url>/API/record</code>
  
 JSON Object keys : JSON Object keys :
Ligne 88: Ligne 93:
 <code> <code>
 [{ [{
-    "IdSoc": "FC",+    "IdSoc": "VEO",
     "IdCli": "9876543210",     "IdCli": "9876543210",
     "IdRecord": "10212",     "IdRecord": "10212",
Ligne 94: Ligne 99:
     "LibRecord": "Facture Mai 2018",     "LibRecord": "Facture Mai 2018",
     "MontantTTC": 903.30,     "MontantTTC": 903.30,
-    "DateRecord": "2018-06-05"+    "DateRecord": "2018-06-05", 
 +    "Meta:JOURNAL": "700", 
 +    "Meta:PROJET": "Webdesign SPHERE"
 },{ },{
-    "IdSoc": "FC",+    "IdSoc": "VEO",
     "IdCli": "9876543210",     "IdCli": "9876543210",
     "IdRecord": "10399",     "IdRecord": "10399",
Ligne 102: Ligne 109:
     "LibRecord": "Réglement par virement",     "LibRecord": "Réglement par virement",
     "MontantTTC": 250.00,     "MontantTTC": 250.00,
-    "DateRecord": "2018-07-01"+    "DateRecord": "2018-07-01", 
 +    "Meta:JOURNAL": "501"
 }] }]
 </code> </code>
 +
 +
 +=== Modification en masse - Méthode ACTION ===
 +
 +<code>POST https://<server-url>/API/action</code>
 +
 +JSON Object keys :
 +  * **IdSoc** : Code société / entité
 +  * **IdCli** : Identification unique du tiers
 +  * **IdRecord** : (optionnel) Identification de la pièce
 +  * **ActionTxt** : Action/reprise - Commentaire de l'action
 +  * **AccAffectation** : Chgmt - Affectation (CR)
 +  * **StatusPrimary** : Chgmt - Statut du compte / pièce (ex: Action externe / Promesse)
 +  * **StatusSub** : Chgmt - Sous-status (ex: Litige ADV / Réglement CB)
 +  * **ScenMode** : Chgmt - Mode scénario (ex: AUTO/STOP/FORCE/PAUSE)
 +  * **ScenCode** : Chgmt - Changement scénario (ex: "Scénario 5")
 +
 +Notes :
 +  * Ce format est également accessible par chargement CSV/Excel sous le libellé **Fiche navette : Modification en masse**.
 +  * Les intitulés de colonnes reprendront les clés décrites ci-dessus.
 +