Passer au contenu principal
Cette procédure explique comment traiter vos premières factures avec l’API ABBYY FlexiCapture for Invoices Cloud : créez l’en-tête Authorization, téléversez un fichier, lancez une tâche et téléchargez les résultats. Tous les points de terminaison utilisent l’URL de base https://api-{location-id}.flexicapture.com, où {location-id} correspond à l’emplacement pris en charge : us (USA et Canada), au (Australie) ou eu (pays de l’Union européenne).
1

Créer un compte

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

Récupérer l’en-tête Authorization

Toutes les requêtes adressées à l’API doivent contenir un en-tête Authorization, construit à partir de votre application ID et de votre token. Pour obtenir des instructions, consultez Authentification. Les exemples ci-dessous utilisent l’en-tête d’exemple Basic QWxhZGRpbjpPcGVuU2VzYW1l.
3

Téléverser un fichier

Téléverser un fichier sur le serveur. Vous obtenez l’identifiant et le token du fichier dans la réponse ; ils sont utilisés dans toutes les requêtes suivantes concernant ce fichier.
curl -X POST \
  --header "Accept: application/json" \
  --header "Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l" \
  --form "file=@/path/to/file/Letter.tif" \
  "https://api-{location-id}.flexicapture.com/v2/file"
Les paramètres du projet pour l’assemblage de documents sont ignorés lors du téléversement d’un fichier via l’API REST. Un document distinct est créé pour chaque fichier.
4

Démarrer une tâche

Une fois votre document téléversé, démarrez une tâche pour lancer l’extraction de données. Vous pouvez spécifier plusieurs fichiers dans cette requête. La requête peut contenir les paramètres facultatifs suivants : région de facture, type de vérification et format d’export des résultats. La réponse contient 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"
5

Obtenir le statut d'une tâche

Le traitement de la tâche prend un certain temps, les données extraites ne sont donc pas disponibles immédiatement. Vous pouvez vérifier le statut de la tâche à l’aide de l’identifiant que vous avez reçu lors du 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"
6

Télécharger le résultat

Une fois que le statut de tâche passe à Done, vous pouvez télécharger les fichiers de sortie à l’aide de leurs identifiants et tokens. Répétez cette requête pour chaque fichier d’entrée inclus dans 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"
7

Supprimer la tâche

Après avoir téléchargé les données de sortie, supprimez la tâche pour effacer 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"