Passer au contenu principal
Un scénario typique pour traiter des documents à l’aide d’un seul appel d’API (pour créer une transaction, téléverser un fichier et démarrer cette transaction) comprend les étapes suivantes :
  1. Réception de la liste de toutes les Skills disponibles.
  2. Création et démarrage d’une transaction.
  3. Suivi de l’état de la transaction.
  4. Téléchargement des fichiers source et des fichiers de résultats.
Chaque requête envoyée au serveur doit inclure des informations d’authentification. Pour plus d’informations, voir Authentication. Utilisez ce scénario si vous avez un fichier dont la taille est inférieure à 30 Mo et que vous n’avez pas besoin de modifier les images de ce fichier.

​
Étape 1. Obtenir la liste de tous les Skills disponibles

Pour obtenir la liste de tous les Skills disponibles, envoyez une requête GET à la ressource skills : Exécutez la commande suivante : Par conséquent, vous recevrez des informations sur tous les Skills ajoutés à l’instance de l’application.

​
Étape 2. Créer et lancer une transaction

Pour créer et lancer une transaction, envoyez une requête POST à la ressource transactions/launch : Dans l’URL, spécifiez le paramètre de requête skillId (renvoyé par l’appel d’API précédent). Dans le corps de la requête, envoyez le fichier à traiter avec les métadonnées facultatives. Vous pouvez également transmettre les paramètres facultatifs registrationParameters et skillParameters dans le corps de la requête. Voici un exemple de corps de requête : 
{
  "files": [
    {
    }
  ]
}
Exécutez la commande suivante : Vous recevrez une réponse contenant l’id de la transaction créée.

​
Étape 3. Surveiller l’état de la transaction

Pour ce faire, envoyez une requête GET vers la ressource transactions : Exécutez la commande suivante : 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.

​
Étape 4. Télécharger les fichiers source et les fichiers de résultat

Pour télécharger les fichiers source et les fichiers de résultat, 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 : Exécutez la commande suivante :