Obtenir une liste de transactions

Une liste de toutes les transactions actives ou terminées peut servir à :

Suivre les transactions actives actuellement à l’étape de relecture manuelle.
Obtenir un lien de relecture manuelle pour les transactions actives.
Télécharger les fichiers de résultats des transactions terminées.
Récupérer les transactions achevées dans leur ordre d’achèvement, sans avoir à suivre celles que vous avez déjà collectées.

Vous pouvez obtenir une liste de transactions avec leurs identifiants à l’aide de l’API Vantage. Vous pouvez utiliser Skill Monitor pour appliquer des filtres plus avancés.

Liste des transactions actives

Pour obtenir une liste des transactions actives, envoyez une requête GET à la ressource transactions/active. Dans le corps de la requête, indiquez les paramètres suivants :

Parameter	Description
StageType	L’étape de la transaction. Les valeurs possibles sont : - ManuaReview - CustomActivity - Automatic (toutes les étapes pour lesquelles l’intervention de l’utilisateur n’est pas requise, par exemple l’extraction de champs)
StageName	Le nom de l’action spécifique (uniquement pour l’étape ManualReview).
SkillId	L’identifiant de la compétence. Si aucune valeur n’est spécifiée, toutes les compétences disponibles seront prises en compte.
SkillVersion	La version de la compétence. Si aucune valeur n’est spécifiée, toutes les versions des compétences disponibles seront prises en compte.
StartDate	L’horodatage de création de la transaction la plus ancienne (doit être spécifié au format UTC).
EndDate	L’horodatage de création de la transaction la plus récente (doit être spécifié au format UTC). Si cette valeur n’est pas spécifiée, l’heure UTC actuelle sera utilisée à la place.
TransactionParameters	La liste des paramètres de transaction composée de paires clé-valeur de type string. Ces paramètres fournissent des informations utilisateur supplémentaires (par exemple, le nom du client). Les paramètres doivent être fournis au format suivant : `TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}`
DocumentParameters	La liste des paramètres de document composée de paires clé-valeur de type string. Ces paramètres fournissent des informations supplémentaires sur le document (par exemple, le nom du fichier). Les paramètres doivent être fournis au format suivant : `DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}`
Offset	Le décalage de pagination. La valeur par défaut du paramètre est 0.
Limit	La limite de pagination. Ce paramètre est obligatoire. Valeurs acceptées : 1 à 1000.

Exemple de requête :

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"

La réponse à une requête pour laquelle un identifiant de compétence est spécifié contiendra un fichier JSON similaire au suivant :

{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Review",
      "seqId": 13758,
      "transactionId": "56a50415-fe1d-4493-81ba-97ff07e3ffce",
      "createTimeUtc": "2023-09-11T13:53:30.633Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "skillId": "workspace.default.processing",
      "skillVersion": 18,
      "documentCount": 1
    }
  ],
  "totalItemCount": 7
}

La réponse à une requête pour laquelle une étape et une action sont spécifiées contiendra un fichier JSON contenant toutes les transactions actives, similaire à ce qui suit :

{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Review2",
      "seqId": 13852,
      "transactionId": "e646754e-d854-4b21-af91-58cb63ead7a6",
      "createTimeUtc": "2023-09-11T14:04:37.97Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "documentCount": 1
    }
  ],
  "totalItemCount": 2
}

Vous pouvez également obtenir un lien client de relecture manuelle pour les transactions actives. Pour ce faire, envoyez une requête GET à la ressource transactions/<transaction_id> avec l’identifiant de la transaction dans l’URI de la requête. Exemple de requête :

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

La réponse contiendra un code semblable à ce qui suit :

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Processing",
  "manualReviewLink": "https://vantage-us.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
  "sourceFiles": [
    {
      "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
      "name": "Invoice07.JPG"
    }
  ]
}

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Processing",
  "manualReviewLink": "https://vantage-eu.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
  "sourceFiles": [
    {
      "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
      "name": "Invoice07.JPG"
    }
  ]
}

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Processing",
  "manualReviewLink": "https://vantage-au.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
  "sourceFiles": [
    {
      "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
      "name": "Invoice07.JPG"
    }
  ]
}

La clé manualReviewLink contiendra un lien vers l’interface Web du client de relecture manuelle ainsi qu’un jeton d’accès Vantage, si une relecture manuelle est requise. Ce lien et ce jeton peuvent être utilisés pour vérifier et corriger les résultats de classification et d’extraction des champs d’une transaction spécifique. Le lien fourni est valide pendant 168 heures, après quoi un nouveau lien doit être créé et récupéré pour une nouvelle période de 168 heures en utilisant la même méthode. Pour plus d’informations, voir Intégration de la relecture manuelle.

Les utilisateurs autorisés via ce lien ne pourront pas afficher ni modifier d’autres documents ou transactions.

Liste des transactions terminées

Pour obtenir une liste des transactions terminées, envoyez une requête GET à la ressource transactions/completed. Dans le corps de la requête, spécifiez les paramètres suivants :

Parameter	Description
TransactionStatus	Le statut de la transaction. Les valeurs possibles sont : - Processed - Cancelled - Failed
SkillId	L’identifiant de la compétence. Si aucune valeur n’est spécifiée, toutes les compétences disponibles seront prises en compte.
SkillVersion	La version de la compétence. Si aucune valeur n’est spécifiée, toutes les versions des compétences disponibles seront prises en compte.
StartDate	L’horodatage de création de la première transaction (doit être spécifiée au format UTC).
EndDate	L’horodatage de création de la dernière transaction (doit être spécifiée au format UTC). Si cette valeur n’est pas spécifiée, l’heure UTC actuelle sera utilisée à la place.
TransactionParameters	La liste des paramètres de transaction, composée de paires clé-valeur de type string. Ces paramètres fournissent des informations supplémentaires sur l’utilisateur (par exemple, le nom du client). Les paramètres doivent être fournis au format suivant : `TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}`
DocumentParameters	La liste des paramètres de document, composée de paires clé-valeur de type string. Ces paramètres fournissent des informations supplémentaires sur le document (par exemple, le nom du fichier). Les paramètres doivent être fournis au format suivant : `DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}`
Offset	Le décalage de pagination. La valeur par défaut de ce paramètre est 0.
Limit	La limite de pagination. Ce paramètre est obligatoire. Valeurs acceptées : 1 à 1000.

La réponse contiendra un fichier JSON avec toutes les transactions terminées et un nombre de pages traitées similaire à ce qui suit :

{
  "items": [
    {
      "status": "Processed",
      "pageCount": 1,
      "transactionId": "fc9920fe-f788-47f8-9972-b767493faed9",
      "createTimeUtc": "2023-09-11T13:47:50.273Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 1,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "transactionId": "c0dd3e08-f295-4c6c-b919-31eaa67817cc",
      "createTimeUtc": "2023-09-12T19:28:01.27Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed _1_.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "transactionId": "8391871e-abf5-41bc-8a66-1059418a3843",
      "createTimeUtc": "2023-09-13T08:53:41.9Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed _1_.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "transactionId": "7f7cd557-a03e-42e3-a454-e7981e8e9fc0",
      "createTimeUtc": "2023-09-13T09:35:27.48Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "transactionId": "c9b3cd4d-d90f-48be-adc2-99985ece4e11",
      "createTimeUtc": "2023-09-13T09:38:29.573Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    }
  ],
  "totalItemCount": 5
}

Récupération des transactions terminées

La ressource transactions/completed renvoie toutes les transactions terminées sur une plage de dates ; une intégration qui collecte les résultats doit donc tenir son propre registre des transactions qu’elle a déjà traitées. La ressource transactions/pending-pickup supprime ce besoin de suivi. Elle renvoie les transactions achevées que vous n’avez pas encore supprimées, dans leur ordre d’achèvement, et une transaction disparaît de la liste dès que vous la supprimez. Une boucle de récupération typique se présente ainsi :

Envoyez une requête GET à transactions/pending-pickup.
Pour chaque transaction renvoyée, téléchargez les fichiers de résultat. Voir Téléchargement des fichiers sources et des fichiers de résultat.
Supprimez la transaction à l’aide d’une requête DELETE vers transactions/<transaction_id>. Elle est ainsi retirée de la liste de récupération.
Si la réponse contient un nextCursor, reprenez à l’étape 1 avec ce curseur pour obtenir la page suivante. Lorsque nextCursor est vide, vous avez atteint la fin de la liste. Attendez l’expiration de votre intervalle d’interrogation, puis recommencez sans curseur.

Dans la requête, spécifiez les paramètres suivants :

Parameter	Description
Limit	Le nombre maximal de transactions à renvoyer dans une page. Valeurs acceptées : 1 à 1000.
Cursor	La valeur `nextCursor` de la réponse précédente. Omettez-la pour commencer par la transaction achevée la plus ancienne qui n’a pas été supprimée. Traitez le curseur comme une string opaque.
Status	Le statut de la transaction. Les valeurs possibles sont les suivantes : - Processed - Cancelled - Failed Si aucune valeur n’est spécifiée, les transactions présentant l’un ou l’autre de ces statuts sont renvoyées. Pour filtrer selon plusieurs statuts, séparez les valeurs par des virgules.
SkillId	L’identifiant de la compétence. Si aucune valeur n’est spécifiée, toutes les compétences disponibles sont prises en compte. Les transactions de chaque version de la compétence sont renvoyées.

Exemple de requête :

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Status=Processed" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Status=Processed" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Status=Processed" \
  -H "Authorization: Bearer token"

La réponse contient les transactions achevées ainsi qu’un curseur pour la page suivante :

{
  "items": [
    {
      "transactionId": "fc9920fe-f788-47f8-9972-b767493faed9",
      "status": "Processed",
      "finishedTimeUtc": "2026-06-10T12:34:56Z"
    },
    {
      "transactionId": "c0dd3e08-f295-4c6c-b919-31eaa67817cc",
      "status": "Failed",
      "finishedTimeUtc": "2026-06-10T12:35:02Z"
    }
  ],
  "nextCursor": "Q3Vyc29yRXhhbXBsZQ=="
}

Pour obtenir la page suivante, renvoyez le curseur dans la requête :

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Cursor=Q3Vyc29yRXhhbXBsZQ==" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Cursor=Q3Vyc29yRXhhbXBsZQ==" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Cursor=Q3Vyc29yRXhhbXBsZQ==" \
  -H "Authorization: Bearer token"

Gardez les points suivants à l’esprit lorsque vous développez une intégration de récupération :

La livraison est garantie au moins une fois. Chaque transaction achevée apparaît au moins une fois, mais dans certains cas, comme durant les quelques minutes séparant une requête DELETE de la suppression effective, le même transactionId peut apparaître plusieurs fois. Conservez les identifiants que vous avez déjà traités et ignorez ceux qui réapparaissent.
Récupérez les résultats avant leur expiration. Une transaction reste dans la liste de récupération tant que ses données sont conservées dans Vantage. Si la transaction est supprimée par la politique de conservation des données avant que vous ne l’ayez récupérée, elle n’apparaît plus dans la liste. Les enregistrements historiques restent disponibles dans la Reporting API.
Autorisations. La requête ne renvoie que les transactions des compétences auxquelles l’utilisateur authentifié a l’autorisation d’accéder, comme pour transactions/completed.
Intervalle d’interrogation. La liste de récupération fonctionne uniquement en mode extraction. Interrogez-la à une fréquence adaptée à la rapidité avec laquelle vous avez besoin des résultats, plutôt qu’en continu. Pour des recommandations générales, consultez Polling.

Overview

Developer Guide

Obtenir une liste de transactions

Liste des transactions actives

Liste des transactions terminées

Récupération des transactions terminées

​Liste des transactions actives

​Liste des transactions terminées

​Récupération des transactions terminées

Liste des transactions actives

Liste des transactions terminées

Récupération des transactions terminées