Passer au contenu principal
Un scénario type pour traiter des documents avec un seul appel API (création d’une transaction, téléversement d’un fichier et démarrage de la transaction) se déroule en étapes suivantes :
  1. Récupération de la liste de toutes les Skills disponibles
  2. Création et démarrage de la transaction
  3. Suivi de l’état de la transaction
  4. Téléchargement des fichiers sources et des fichiers de résultats
Chaque requête adressée au serveur doit inclure des informations d’authentification. Pour en savoir plus, consultez Authentication. Utilisez ce scénario si vous n’avez qu’un seul fichier de moins de 30 Mo et que vous n’avez pas besoin de modifier les images du fichier.

​
Obtenir la liste de tous les Skills disponibles

Pour ce faire, envoyez une requête GET à la ressource skills : 
GET https://your-server/api/publicapi/v1/skills
Exécutez la commande suivante : Sous Windows : 
curl -X GET "https://your-server/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"
Sous Linux : 
curl -X GET 'https://your-server/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'
Par conséquent, vous recevrez des informations sur tous les Skills ajoutés à l’instance de l’application.

​
Création et lancement d’une transaction

Pour cela, envoyez une requête POST au point de terminaison transactions/launch : 
POST https://votre-serveur/api/publicapi/v1/transactions/launch
Dans le corps de la requête, indiquez le Parameter skillId renvoyé par l’appel d’API précédent, puis envoyez le fichier à traiter. Voici un exemple de corps de requête : 
{
  "settings": {
    "skillId": "00000000-0000-0000-0000-000000000001"
  },
  "files": [
    {
      "file": "image content"
    }
  ]
}
Exécutez la commande suivante : Sous Windows : 
curl -X POST "https://your-server/api/publicapi/v1/transactions/launch" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"settings\": {
     \"skillId\": \"00000000-0000-0000-0000-000000000001\"
   },
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Pour Linux : 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/launch' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "settings": {
     "skillId": "00000000-0000-0000-0000-000000000001"
   },
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'
Vous recevrez alors une réponse contenant l’ID de la transaction créée.

​
Surveiller l’état de la transaction

Pour ce faire, envoyez une requête GET vers la ressource transactions : 
GET https://your-server/api/publicapi/v1/transactions/transaction-id
Exécutez la commande suivante : Sous Windows : 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"
Sous Linux : 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'
En conséquence, vous recevrez une réponse indiquant l’état de la transaction. Le traitement de la transaction peut être dans l’un des états suivants :
  • New. La transaction a été créée mais n’a pas encore été mise en file d’attente pour traitement.
  • Queued. La transaction est en file d’attente pour traitement.
  • InProgress. La transaction est en cours de traitement.
  • Processed. La transaction a été traitée avec succès.
  • ProcessedWithWarnings. La transaction a été traitée, mais des avertissements se sont produits.
  • NotProcessed. La transaction n’a pas été traitée en raison d’une erreur.
  • Deleted. La transaction a été supprimée par l’utilisateur ou automatiquement conformément à la stratégie de conservation.
Si l’état de la transaction est Processed ou ProcessedWithWarnings, passez à l’étape 4.

​
Téléchargement des fichiers source et des fichiers de résultat

Pour télécharger le fichier source, envoyez une requête GET à la ressource transactions/files/download, en spécifiant l’ID du fichier reçu lors de la requête précédente : 
GET https://votre-serveur/api/publicapi/v1/transactions/transaction-id/files/file-id/download
Exécutez la commande suivante : Sous Windows : 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"
Sous Linux : 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'