Passer au contenu principal

​
Obtenir une liste de transactions

Vous pouvez utiliser une liste de toutes les transactions actives ou terminées pour :
  • 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ésultat des transactions terminé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 vers la ressource transactions/active. Dans le corps de la requête, indiquez les paramètres suivants :
ParameterDescription
StageTypeL’étape de la transaction.
Valeurs possibles :
- ManuaReview
- CustomActivity
- Automatic (toutes les étapes ne nécessitant pas d’intervention de l’utilisateur, par exemple l’extraction de champs)
StageNameLe nom de l’action spécifique (uniquement pour l’étape ManualReview).
SkillIdL’identifiant du Skill.
Si aucune valeur n’est indiquée, tous les Skills disponibles seront pris en compte.
SkillVersionLa version du Skill.
Si aucune valeur n’est indiquée, toutes les versions des Skills disponibles seront prises en compte.
StartDateL’heure de création de la transaction la plus ancienne (doit être au format UTC).
EndDateL’heure de création de la transaction la plus récente (doit être au format UTC).
Si aucune valeur n’est indiquée, l’heure UTC actuelle sera utilisée.
TransactionParametersLa 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”}
DocumentParametersLa 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 de fichier).
Les paramètres doivent être fournis au format suivant : DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}
OffsetLe décalage de pagination.
La valeur par défaut de ce paramètre est 0.
LimitLa limite de pagination. Paramètre requis.
La valeur par défaut de ce paramètre est 0.
Exemple de requête (Windows) : 
curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"
Également disponible dans d’autres régions : 
# Amérique du Nord
curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active" \
  -H "Authorization: Bearer token"

# Australie
curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/active" \
  -H "Authorization: Bearer token"
Exemple de requête (Linux) : 
curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'
Disponible également pour d’autres régions : 
# Amérique du Nord
curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'

# Australie
curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'
La réponse à une requête avec un identifiant de Skill spécifié contiendra un fichier JSON semblable à ce qui suit : 
{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Révision",
      "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 avec une étape et une action spécifiées contiendra un fichier JSON répertoriant 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 en cours. 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 (Windows) : 
curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"
Également disponible dans d’autres régions : 
# Amérique du Nord
curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

# Australie
curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"
Exemple de requête (Linux) : 
curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
  -H 'Authorization: Bearer token'
Également disponible dans d’autres régions : 
# Amérique du Nord
curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
  -H 'Authorization: Bearer token'

# Australie
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": "Traitement en cours",
  "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": "Traitement en cours",
  "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": "Traitement en cours",
  "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 contient un lien vers l’interface web du client Manual Review ainsi qu’un jeton d’accès Vantage, si une relecture manuelle est requise. Ce lien et ce jeton peuvent être utilisés pour examiner et corriger les résultats de classification et d’extraction de champs d’une transaction donnée. Le lien fourni est valide pendant 168 heures, après quoi un nouveau lien doit être créé et obtenu 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 vers la ressource transactions/completed. Dans le corps de la requête, spécifiez les paramètres :
ParameterDescription
TransactionStatusLe statut de la transaction.
Valeurs possibles :
- Processed
- Canceled
- Failed
SkillIdL’identifiant du Skill.
Si aucune valeur n’est spécifiée, tous les Skills disponibles seront pris en compte.
SkillVersionLa version du Skill.
Si aucune valeur n’est spécifiée, toutes les versions des Skills disponibles seront prises en compte.
StartDateL’horodatage de création de la transaction la plus ancienne (à spécifier au format UTC).
EndDateL’horodatage de création de la transaction la plus récente (à spécifier au format UTC).
Si cette valeur n’est pas spécifiée, l’heure UTC actuelle sera utilisée.
TransactionParametersLa 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”}
DocumentParametersLa 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 de fichier).
Les paramètres doivent être fournis au format suivant : DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}
OffsetLe décalage de pagination.
La valeur par défaut de ce paramètre est 0.
LimitLa limite de pagination. Paramètre requis.
La valeur par défaut de ce paramètre est 0.
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": "FinishedSuccessfully",
      "pageCount": 1,
      "seqId": 13705,
      "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"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 29842,
      "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"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36254,
      "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"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36632,
      "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"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36663,
      "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"
        }
      ],
      "documentCount": 1
    }
  ],
  "totalItemCount": 5
}