Passer au contenu principal

Créer un compte

Pour interagir avec l’API, vous avez besoin d’un compte. Si vous n’avez pas encore créé de compte, faites-le sur le portail web ABBYY FlexiCapture Cloud.

Obtenir l’en-tête Authorization

Toutes les requêtes adressées à l’API doivent contenir un en-tête Authorization. Pour obtenir l’en-tête Authorization :
  1. Concaténez l’ID de l’application et le jeton en utilisant les deux-points comme séparateur (vous trouverez l’ID de l’application et le jeton sur la page Applications du portail web ABBYY FlexiCapture Cloud).
  2. Encodez la chaîne obtenue à l’aide de n’importe quelle variante de Base64.
  3. Ajoutez la méthode d’autorisation, suivie d’un espace, devant la chaîne de l’étape 2.
ID de l’application = Aladdin, jeton = OpenSesame
  1. Concaténez l’ID de l’application et le jeton :
Aladdin:OpenSesame
  1. Encodez la chaîne à l’aide de n’importe quelle variante de Base64 :
QWxhZGRpbjpPcGVuU2VzYW1l
  1. Ajoutez la méthode d’autorisation, suivie d’un espace, devant la chaîne de l’étape 2 :
Basic QWxhZGRpbjpPcGVuU2VzYW1l
  1. L’en-tête Authorization obtenu se présentera comme suit :
Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l

Téléverser un fichier

Téléversez un fichier sur le serveur. Vous recevrez l’identifiant et le jeton du fichier dans la réponse. Cet identifiant et ce jeton seront utilisés dans toutes les requêtes ultérieures concernant ce fichier. curl -X POST —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l” “https://api-{location-id}.flexicapture.com/v2/file” —form “file=@/path/to/file/Letter.tif” location-ids pris en charge : us : USA et Canada, au : Australie, eu : pays de l’Union européenne.
Les paramètres du projet pour l’assemblage des documents seront ignorés lors du téléversement d’un fichier via l’API REST. Un document distinct sera créé pour chaque fichier.

Lancer une tâche

Une fois votre document téléversé, lancez une tâche pour démarrer l’extraction des données. Vous pouvez spécifier plusieurs fichiers dans cette requête. La requête peut contenir les paramètres facultatifs suivants : la région, le type de vérification et le format d’export des résultats. La réponse contiendra un identifiant de tâche. curl -X POST —header “Content-Type: application/json” —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l” -d ”{ “properties”: { “region”: “US”, “export_format”: “Xls”, “verification_type”: “NoVerification”, }, “files”: [ { “id”: “5ea16ff21b777315586713bf”, “token”: “34FB84AA68684F0F2BF496045224EB6C436F596B” } ] }” “https://api-{location-id}.flexicapture.com/v2/task/capture/invoices Location-ids pris en charge : us : USA et Canada, au : Australie, eu : les pays de l’Union européenne.

Obtenir le statut de la requête

Le traitement de la tâche prendra un certain temps ; les données extraites ne seront donc pas disponibles immédiatement. Vous pouvez vérifier le statut de la tâche à l’aide de l’identifiant reçu au démarrage de la tâche. Attendez que le statut passe à Done. curl -X GET —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l” “https://api-{location-id}.flexicapture.com/v2/task/5ea18adc220e0d1c58177c59 Location-ids pris en charge : us : USA et Canada, au : Australie, eu : pays de l’Union européenne.

Télécharger le résultat

Une fois le statut de la tâche passé à Done, vous pouvez télécharger les fichiers de sortie à l’aide de leurs identifiants et jetons. Vous pouvez répéter cette requête pour chaque fichier d’entrée de la requête de tâche. curl -X GET —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l=” “https://api-{location-id}.flexicapture.com/v2/file/5ea21f6b7a9ae6193831d671/D188E5EFC0042A83529899AC1E1D94400A25DCF6 Location-ids pris en charge : us : USA et Canada, au : Australie, eu : les pays de l’Union européenne.

Supprimer la tâche

Après avoir téléchargé les données de sortie, supprimez la tâche afin de supprimer tous les fichiers d’entrée et de sortie. curl -X DELETE —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l=” “https://api-{location-id}.flexicapture.com/v2/task/5ea18adc220e0d1c58177c59 location-ids pris en charge : us : USA et Canada, au : Australie, eu : pays de l’Union européenne.