Passer au contenu principal
Un scénario type de traitement de documents à l’aide d’appels d’API distincts (création d’une transaction, téléversement d’un fichier et démarrage d’une transaction) se déroule comme suit :
  1. Obtenir la liste de toutes les Skills disponibles
  2. Créer une transaction vide
  3. Ajouter un ensemble de fichiers à traiter dans la transaction
  4. Démarrer la transaction
  5. Suivre l’état de la transaction
  6. Télécharger les fichiers source et les fichiers de résultats
Chaque requête adressée au serveur doit inclure des informations d’authentification (par exemple, un jeton d’accès). Pour en savoir plus, consultez Authentication.

​
Récupérer la liste de toutes 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'
En conséquence, vous recevrez des informations sur toutes les compétences ajoutées à l’instance d’application.

​
Création d’une transaction vide

Pour cela, envoyez la requête POST suivante à la ressource transactions : 
POST https://votre-serveur/api/publicapi/v1/transactions
Exécutez la commande suivante : Sous Windows : 
curl -X POST "https://your-server/api/publicapi/v1/transactions" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{
  \"skillId\": \"00000000-0000-0000-0000-000000000001\"
}"
Sous Linux : 
curl -X POST 'https://your-server/api/publicapi/v1/transactions' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
  "skillId": "00000000-0000-0000-0000-000000000001"
}'
Dans le corps de la requête, spécifiez le Parameter skillId renvoyé par l’appel d’API précédent. Vous recevrez alors une réponse contenant l’id de la transaction créée.

​
Ajout d’un ensemble de fichiers à traiter dans la transaction

Important ! Le nombre maximal de fichiers dans une transaction est de 1 000. Un ensemble de fichiers peut être ajouté de deux manières :

​
Ajout de fichiers directement à la transaction

Pour ce faire, envoyez une requête POST vers la ressource transactions/<transaction-id>/files : 
POST https://votre-serveur/api/publicapi/v1/transactions/id-transaction/files
Dans le corps de la requête, envoyez le fichier à traiter. Pour plus d’informations sur les paramètres disponibles pour la personnalisation des fichiers, consultez la référence de l’API. Exécutez la commande suivante : Pour Windows : 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/files" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Pour Linux : 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/files' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'
En conséquence, vous recevrez une réponse contenant la liste des fichiers ajoutés et leurs identifiants. Vous pouvez ajouter autant de fichiers que nécessaire en répétant cet appel autant de fois que nécessaire. Options supplémentaires pour le chargement des fichiers :

​
Ajout de fichiers à un document

Commencez par créer un document en envoyant une requête POST à la ressource transactions/<transaction-id>/documents : 
POST https://votre-serveur/api/publicapi/v1/transactions/transaction-id/documents
Sous Windows : 
curl -X POST "https://votre-serveur/api/publicapi/v1/transactions/id-transaction/documents" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{
  \"documents\": [
    {
    }
  ]
}"
Sous Linux : 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
  "documents": [
    {
    }
  ]
}'
Vous recevrez alors une réponse contenant l’identifiant du document. Ajoutez ensuite des fichiers au document en envoyant une requête POST à la ressource transactions/<transaction-id>/documents/<document-id>/sourceFiles : 
POST https://votre-serveur/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles
Sous Windows : 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Sous Linux : 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'

​
Démarrer la transaction

Pour démarrer la transaction avec la compétence et les fichiers spécifiés, envoyez la requête POST suivante à la ressource transactions/<transaction-id>/start : 
POST https://votre-serveur/api/publicapi/v1/transactions/transaction-id/start
Sous Windows : 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/start" \
-H "accept: */*" \
-H "Authorization: Bearer token"
Sous Linux : 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/start' \
-H 'accept: */*' \
-H 'Authorization: Bearer token'

​
Suivi de l’état de la transaction

Pour commencer à surveiller l’état de la transaction à l’aide d’une boucle avec un court délai d’attente (nous ne recommandons pas de vérifier l’état plus d’une fois par seconde), envoyez une requête GET à la ressource transactions/<transaction_id> en incluant l’identifiant de la transaction dans l’URI de la requête : 
GET https://your-server/api/publicapi/v1/transactions/transaction-id
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 contenant 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é placée dans la file d’attente de traitement.
  • Queued. La transaction est en file d’attente pour le 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 sont survenus.
  • 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 selon la stratégie de conservation.
Si l’état de la transaction est Processed ou ProcessedWithWarnings, passez à l’étape 6.

​
Téléchargement des fichiers source

Pour obtenir la liste des documents avec leurs identifiants, envoyez une requête GET à la ressource transactions/<transaction-id>/documents et indiquez l’identifiant de la transaction : 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/documents
Sous Windows : 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/documents" \
-H "Authorization: Bearer token"
Sous Linux : 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'Authorization: Bearer token'
Par conséquent, vous recevrez la liste de tous les documents créés dans cette transaction. La réponse contient également les identifiants de ces documents, qui peuvent être nécessaires pour obtenir des informations détaillées sur des documents spécifiques. Pour obtenir la liste des fichiers ajoutés à un document donné, envoyez une requête GET à la ressource transactions/<transaction-id>/documents/<document-id> : 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id
Sous Windows : 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id" \
-H "Authorization: Bearer token"
Sous Linux : 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id' \
-H 'Authorization: Bearer token'
En conséquence, vous recevrez des informations sur le document. La réponse contient également les identifiants des fichiers ajoutés au document. Pour télécharger le fichier source, envoyez une requête GET à la ressource transactions/<transaction-id>/files/<file-id>/download : 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download
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'