Passer au contenu principal
L’API Vantage vous permet d’accéder aux paramètres des Compétences de document et de processus et d’en modifier les valeurs pour une transaction donnée. Les paramètres de Skill transmis dans une transaction sont des paires clé‑valeur de type string. Pour les paramètres de Compétence de document et de Compétence de processus, les valeurs définies via l’API Vantage priment sur celles définies via l’interface Vantage.

​
Modification des valeurs de Parameter d’une Skill

Pour modifier les valeurs de Parameter d’une Skill via l’API Vantage, procédez comme suit :

​
Étape 1 : Créer ou initialiser une Transaction

Créez une transaction vide ou initialisez-en une à l’aide de la méthode launch. Pour ce faire, envoyez une requête POST à la ressource transactions : 
POST {your-host}/api/publicapi/v1/transactions
ou 
POST {your-host}/api/publicapi/v1/transactions/launch?skillId={skill-id}
Dans le corps de la requête, indiquez les nouvelles valeurs des paramètres du Skill, puis exécutez la commande suivante :

​
Exemple sous Windows

curl -X POST "{your-host}/api/publicapi/v1/transactions" ^
-H "Authorization: Bearer {token}" ^
-H "Content-Type: application/json" ^
-d "{\"skillId\":\"123\",\"skillParameters\":[{\"key\":\"Nouveau Parameter\",\"value\":\"Vendors nouveau\"}]}"

​
Exemple sous Linux

curl -X POST '{your-host}/api/publicapi/v1/transactions' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{"skillId":"123","skillParameters":[{"key":"New parameter","value":"Vendors new"}]}'
Remarque : Le nombre de paramètres clé‑valeur d’une compétence est limité à 10, chaque clé pouvant contenir jusqu’à 128 caractères et chaque valeur jusqu’à 256 caractères.

​
Récupération des valeurs de Parameter de Skill

Pour récupérer les valeurs de Parameter de Skill à l’aide de l’API Vantage, effectuez l’une des opérations suivantes :

​
Option 1 : Récupérer directement les Parameter du Skill

Envoyez une requête GET à la ressource transactions/{transaction-id}/skillParameters : 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/
La réponse sera similaire à : 
[
  {
    "key": "Nouveau Parameter",
    "value": "Vendors"
  }
]

​
Option 2 : Télécharger les fichiers de la transaction

Envoyez une requête GET au point de terminaison transactions/{transaction-id}/files/{file-id}/download pour obtenir les valeurs au format JSON : 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download