Passer au contenu principal

​
Workflow de l’API REST

Le workflow type de l’API REST est le suivant : Tout projet FlexiCapture destiné à être utilisé avec votre application API REST doit inclure un workflow correctement configuré. Vous trouverez ci-dessous des instructions détaillées expliquant comment adapter le workflow du projet d’exemple Banking Card Application pour l’utiliser avec l’API REST (pour plus d’informations sur les projets d’exemple, consultez la section projets d’exemple ABBYY FlexiCapture). Avant de poursuivre cette procédure, veuillez lancer Project Setup Station et ouvrir le projet d’exemple Banking Card Application (l’emplacement par défaut est C:\Users\Public\ABBYY\FlexiCapture\12.0\Samples\FlexiCapture\English\Banking_eng\banking_eng.fcproj).

​
Ajuster les étapes du workflow

L’API REST soumet toujours les données à traiter avec le type de lot “Default”. Par conséquent, tout le traitement des documents du projet doit être configuré pour le type de lot “Default”.
  1. Dans le menu Projet, cliquez sur Propriétés du projet, puis sur l’onglet Workflow. Dans la liste déroulante Schéma, sélectionnez Avancé et modifiez les paramètres du workflow comme indiqué ci-dessous :
  1. Cliquez sur Vérification → Général et sélectionnez l’option Activer les stations Web. Remarque : Vous pouvez ignorer ce paramètre si vous n’avez pas besoin d’une étape de vérification dans votre projet.
  2. Cliquez sur Vérification → Conditions d’entrée et définissez l’option Les documents sont admis à l’étape sur Toujours. Remarque : Selon les exigences de votre solution, vous pouvez désactiver l’étape de vérification temporairement ou de manière conditionnelle à l’aide d’une règle basée sur un script dans l’onglet Conditions d’entrée.
  1. Pour activer le point de terminaison training/layout/{taskId}/{fileId} pour votre projet, vous devez exporter le fichier XML contenant les données des champs et la mise en page. Pour cela :
    1. Créez une étape de traitement des documents immédiatement avant l’étape de vérification :
  1. Dans l’onglet Conditions d’entrée, choisissez Toujours.
  1. Dans l’onglet Script, cliquez sur le bouton Modifier le script…. : 4. Définissez le langage de script sur C# .NET :
  1. Copiez-collez l’extrait de code suivant dans le volet de script :
using System;
Document.SaveXmlToFileStorage();
  1. Cliquez sur OK pour enregistrer vos modifications.
Les paramètres du projet relatifs à l’assemblage de documents (traitement des images → Créer un document) sont ignorés lors du téléversement des fichiers via l’API REST. Un document distinct sera créé pour chaque fichier.

​
Ajuster les paramètres d’export des données

Une fois qu’un lot soumis via l’API REST a été traité, l’API REST récupère les fichiers exportés afin de les mettre à la disposition du client pour téléchargement.
ABBYY FlexiCapture Cloud stocke les fichiers exportés dans un stockage d’objets. C’est pourquoi vous ne devez pas utiliser de chemins d’export absolus dans votre projet API REST.
Les projets API REST ne nécessitent pas de structure de dossiers particulière. Vous pouvez utiliser une structure de dossiers plate, en reprenant le nom du dossier racine pour chaque lot et les ID des documents dans les noms de fichiers. Les services API REST attribuent à chaque lot soumis via l’API REST un nom de lot unique et aléatoire. Ainsi, des noms de fichiers uniques sont générés lors de l’export des données des lots soumis via l’API REST. La capture d’écran suivante montre les paramètres d’export d’origine, qui produisent une structure de dossiers à plusieurs niveaux : La capture d’écran suivante montre les paramètres d’export modifiés, qui produisent une structure de dossiers plate :

​
Téléversement de votre projet modifié vers ABBYY FlexiCapture Cloud

  1. Cliquez sur File > Upload Project to Server… pour téléverser votre projet vers ABBYY FlexiCapture Cloud.
  2. Dans la boîte de dialogue qui s’ouvre, saisissez l’URL du serveur cloud qui héberge votre tenant et indiquez son nom.
  3. Sélectionnez Use server authentication et saisissez les identifiants de l’administrateur de votre tenant.
  4. Cliquez sur Test connection pour vérifier vos paramètres de connexion.
  5. Cliquez sur OK, puis attendez que votre projet soit téléversé.

​
Vos prochaines étapes

Une fois votre projet téléversé dans ABBYY FlexiCapture Cloud, voici ce que vous pouvez faire ensuite :
  1. Créez une application connectée à votre projet. Pour plus d’informations sur la marche à suivre, consultez Création d’applications à l’aide de l’interface REST API de FlexiCapture.
  2. Pour vérifier que votre application est correctement connectée, traitez un batch d’exemple.
  3. Si vous rencontrez des problèmes, veuillez consulter Diagnostic des erreurs de traitement.