Données traitées par Vantage Mobile Input

Vantage Mobile Upload communique avec le serveur Vantage par le biais d’appel d’API. Ces appels sont utilisés pour créer des documents, téléverser des images et lancer le traitement de transactions avec certains paramètres.

Appels d’API par plateforme

Plateforme iOS

La micro‑application iOS de Vantage Mobile Input utilise les appels d’API suivants :

Envoi des paramètres de la session de saisie au Vantage Mobile Upload Backend
Récupération des paramètres de la session de saisie depuis le Vantage Mobile Upload Backend
Récupération de l’état de la transaction
Téléchargement de modèles pour analyser les images des documents
Récupération de la liste des documents de la transaction
Suppression des documents existants dans la transaction
Création d’un document dans la transaction
Téléversement des images capturées dans le document
Démarrage de la transaction

Plateforme Android

La micro-application Android de Vantage Mobile Input utilise les appels d’API suivants :

Récupération de l’état de la transaction
Téléchargement de modèles pour l’analyse des images des documents
Récupération de la liste des documents de la transaction
Suppression des documents existants dans la transaction
Création d’un document dans la transaction
Téléchargement des images capturées dans le document
Démarrage de la transaction

Envoi des paramètres de session d’entrée au Vantage Mobile Upload Backend

Vantage Mobile Input envoie les paramètres de session d’entrée au Vantage Mobile Upload Backend. Ces paramètres sont utilisés pour la session de téléversement dans la micro-application Android ou le navigateur web.

Paramètres de la session d’entrée

Clé	Description
BaseURL	Le domaine principal du serveur Vantage.
TransactionID	L’identifiant de la transaction.
Token	Le jeton d’accès d’autorisation encodé utilisé pour accéder à l’API Vantage.
v	La version de l’API Vantage.
md	Le nombre de documents à capturer dans une même transaction.
redirect_uri	Le lien de redirection qui s’ouvre une fois Vantage Mobile Upload terminé.
dt	Le type de document.
ma	L’adresse de l’environnement cloud ABBYY Vantage utilisée pour lancer les micro-applications pour les installations on-premises.

Requête :

curl -X POST "https://mobilesessionmanager-eu.abbyy.com/api/v1/mobilesessions"
-H "accept: text/plain" \
-H "Content-Type: application/json" \
-F "Body=
    {
      "sessionAuxiliaryKey": "string",
      "sessionData": "string"
    }

Réponse :

Code de statut de la requête

Récupérer les paramètres de la session d’entrée depuis Vantage Mobile Upload Backend

Pour obtenir les paramètres de la session d’entrée, Vantage Mobile Upload envoie des requêtes à Vantage Mobile Upload Backend.

Paramètres de la session d’entrée

Clé	Description
BaseURL	Le domaine principal du serveur Vantage.
TransactionID	L’identifiant de la transaction.
Token	Le jeton d’accès d’autorisation encodé utilisé pour accéder à l’API Vantage.
v	La version de l’API Vantage.
md	Le nombre de documents à capturer dans une seule transaction.
redirect_uri	Le lien de redirection qui s’ouvre une fois Vantage Mobile Upload terminé.
dt	Le type de document.
ma	L’adresse de l’environnement cloud ABBYY Vantage utilisée pour démarrer les micro-applications dans les installations on-premises.

Requête :

curl -X POST "https://mobilesessionmanager-eu.abbyy.com/api/v1/mobilesessions/retrive"
-H "accept: text/plain" \
-H "Content-Type: application/json" \
-F "Body=
    {
      "userCode": "String"
    }

Réponse :

{
   "sessionData": "<Input Session Parameters>"
}

Exemple de paramètres d’une session d’entrée :

{
\"sessionData\": \"https://mobilesessionmanager-eu.abbyy.com/mobile?baseUrl=<https://vantage-us.abbyy.com>&transactionId=<transaction-id>&token=<token>&v=<release_version>\"
}

{
\"sessionData\": \"https://mobilesessionmanager-eu.abbyy.com/mobile?baseUrl=<https://vantage-eu.abbyy.com>&transactionId=<transaction-id>&token=<token>&v=<release_version>\"
}

{
\"sessionData\": \"https://mobilesessionmanager-eu.abbyy.com/mobile?baseUrl=<https://vantage-au.abbyy.com>&transactionId=<transaction-id>&token=<token>&v=<release_version>\"
}

Récupération du statut de la transaction

Vantage Mobile Upload envoie une requête pour obtenir l’identifiant et le statut de la transaction. Seules les transactions ayant le statut New peuvent être utilisées pour téléverser des documents. Paramètres clés

Clé	Description
TransactionID	L’identifiant de la transaction.
Status	Le statut de la transaction. Valeurs possibles : New, Processing, Processed, Failed, Canceled

Requête :

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id

Réponse :

{
   "id": "<TransactionID>",
   "status": "<Status>"
}

Téléchargement des modèles pour analyser les images des documents

Vantage Mobile Upload envoie des requêtes pour télécharger les modèles utilisés pour détecter les bords de page dans les images des documents pour la micro-application iOS. Paramètres clés

Key	Description
AbbyyRtrSDK-version	Version du framework AbbyyRtrSDK utilisée pour demander les fichiers de modèle appropriés. La valeur peut varier selon la version de Vantage.
PatternFileName	Nom du fichier de modèle AbbyyRtrSDK utilisé pour détecter les bords de page dans les images des documents. Il existe six types de fichiers de modèle : `FactCrop.imodel`, `CnnCrop.Classifier.cnnmodel`, `DIQClassifier.imodel`, `CnnCrop.Detector.GenericWithID.cnnmodel`, `DIQBlockClassifier.imodel`, `CropClassifierPhoto.imodel`

Requête :

GET https://vantage-us.abbyy.com/app_clip/mobile_sdk_assets/AbbyyRtrSDK-version/patterns/PatternFileName

GET https://vantage-eu.abbyy.com/app_clip/mobile_sdk_assets/AbbyyRtrSDK-version/patterns/PatternFileName

GET https://vantage-au.abbyy.com/app_clip/mobile_sdk_assets/AbbyyRtrSDK-version/patterns/PatternFileName

Réponse :

File pattern

Obtenir la liste des documents de la transaction

Avant de téléverser des documents dans la transaction, Vantage Mobile Upload envoie une requête pour vérifier si la transaction contient des documents déjà créés. Si la transaction n’est pas vide, Vantage Mobile Upload envoie une requête Suppression d’un document pour supprimer tous les documents existants avant une nouvelle session de téléversement. Paramètres clés

Clé	Description
TransactionID	L’identifiant de la transaction.
DocumentID	L’identifiant du document reçu à partir de la requête Création d’un document.
SourceFileID	L’identifiant de l’image du document.
SourceFileName	Le nom de l’image du document. Vantage Mobile Upload génère automatiquement des noms de fichier pour chaque image et téléverse les images dans le document à l’aide de la requête Téléversement d’images dans le document.

Requête :

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents

Réponse :

[
   {
      "documentId": "<DocumentID>",
      "sourceFiles": 
      [
         {
           "id": "<SourceFileID>",
           "name": "<SourceFileName>.JPG"
         }
      ]
   }, 
   {
      "documentId": "<DocumentID>",
      "sourceFiles": 
      [
         {
           "id": "<SourceFileID>",
           "name": "<SourceFileName>.JPG"
         }
      ]
   }
]

Suppression des documents existants dans la transaction

Pour supprimer un document de la transaction avant de lancer le traitement, utilisez DELETE /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}. Cela permet aux utilisateurs de :

Supprimer des documents mal capturés
Vider les documents avant une nouvelle capture
Gérer les ensembles de documents de la transaction

Les documents ne peuvent être supprimés qu’avant le début du traitement de la transaction.

Création d’un document au sein de la transaction

Pour téléverser des images, Vantage Mobile Upload envoie une requête afin de créer des instances de document pour chaque document de la transaction. Paramètres clés

Clé	Description
Token	Le jeton d’accès d’autorisation encodé utilisé pour accéder à l’API Vantage.
TransactionID	L’identifiant de la transaction.
DocumentID	L’identifiant du document.

Requête :

curl -X POST "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json; charset=utf-8" \
-F "Model=
    {
      "index": <Unsigned Integer Value: document index in UI>,
      "imageProcessingOptions": 
        {
           "autoOrientationCorrection": "<Yes/No/Default>",
           "autoCrop": "<Yes/No/Default>"
        }
    }

curl -X POST "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json; charset=utf-8" \
-F "Model=
    {
      "index": <Unsigned Integer Value: document index in UI>,
      "imageProcessingOptions": 
        {
           "autoOrientationCorrection": "<Yes/No/Default>",
           "autoCrop": "<Yes/No/Default>"
        }
    }

curl -X POST "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json; charset=utf-8" \
-F "Model=
    {
      "index": <Unsigned Integer Value: document index in UI>,
      "imageProcessingOptions": 
        {
           "autoOrientationCorrection": "<Yes/No/Default>",
           "autoCrop": "<Yes/No/Default>"
        }
    }

Réponse :

{
   "documentId": "<DocumentID>"
}

Téléversement des images capturées dans le document

Une fois l’instance de document créée, Vantage Mobile Upload envoie une requête pour téléverser toutes les images dans le document. Toutes les images d’un même document sont téléversées en une seule requête. Paramètres clés

Key	Description
Token	Le jeton d’accès d’autorisation encodé utilisé pour accéder à l’API Vantage.
TransactionID	L’identifiant de la transaction.
DocumentID	L’identifiant du document reçu dans la requête Création d’un document.
SourceFileID	L’identifiant de l’image du document.
SourceFileName	Le nom de l’image du document. Vantage Mobile Upload génère automatiquement un nom de fichier pour chaque image et téléverse les images dans le document.
ImageData	Les données encodées des fichiers image. Utilisées pour téléverser des images dans des documents.

Requête :

curl -X POST "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data; boundary=<Boundary>" \
-F "Body=
    {
      "files": [
       {
         "index": 0,
         "registrationParameters": [
           {
            "key": "SourceType",
            "value": "Vantage Mobile Capture"
           }
         ]
        }
       ]
    },
    {
      "index": 1,
      ...
    },
      ...
   ]
 }

<Boundary>
Content-Disposition: form-data; name="Files"; filename="<SourceFileName>.JPG"
Content-Type: image/jpeg
<ImageData>

...
<Boundary>
Content-Disposition: form-data; name="Files"; filename="<SourceFileName>.JPG"
Content-Type: image/jpeg
<ImageData>
...
<Boundary>

curl -X POST "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data; boundary=<Boundary>" \
-F "Body=
    {
      "files": [
       {
         "index": 0,
         "registrationParameters": [
           {
            "key": "SourceType",
            "value": "Vantage Mobile Capture"
           }
         ]
        }
       ]
    },
    {
      "index": 1,
      ...
    },
      ...
   ]
 }

<Boundary>
Content-Disposition: form-data; name="Files"; filename="<SourceFileName>.JPG"
Content-Type: image/jpeg
<ImageData>

...
<Boundary>
Content-Disposition: form-data; name="Files"; filename="<SourceFileName>.JPG"
Content-Type: image/jpeg
<ImageData>
...
<Boundary>

curl -X POST "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data; boundary=<Boundary>" \
-F "Body=
    {
      "files": [
       {
         "index": 0,
         "registrationParameters": [
           {
            "key": "SourceType",
            "value": "Vantage Mobile Capture"
           }
         ]
        }
       ]
    },
    {
      "index": 1,
      ...
    },
      ...
   ]
 }

<Boundary>
Content-Disposition: form-data; name="Files"; filename="<SourceFileName>.JPG"
Content-Type: image/jpeg
<ImageData>

...
<Boundary>
Content-Disposition: form-data; name="Files"; filename="<SourceFileName>.JPG"
Content-Type: image/jpeg
<ImageData>
...
<Boundary>

Réponse :

Code de statut de la requête

Démarrage de la transaction

Une fois que tous les documents ont été créés et que toutes les images ont été téléversées dans les documents, Vantage Mobile Upload envoie une requête pour démarrer la transaction. Paramètres clés

Clé	Description
Token	Le jeton d’accès d’autorisation encodé utilisé pour l’accès autorisé à l’API Vantage.
TransactionID	L’identifiant de la transaction.

Requête :

curl -X POST "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/start"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json; charset=utf-8" \

curl -X POST "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/start"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json; charset=utf-8" \

curl -X POST "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/start"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json; charset=utf-8" \

Réponse :

Code de statut de la requête

Vue d’ensemble

Guide du développeur

Données traitées par Vantage Mobile Input

Appels d’API par plateforme

Plateforme iOS

Plateforme Android

Envoi des paramètres de session d’entrée au Vantage Mobile Upload Backend

Paramètres de la session d’entrée

Récupérer les paramètres de la session d’entrée depuis Vantage Mobile Upload Backend

Paramètres de la session d’entrée

Récupération du statut de la transaction

Téléchargement des modèles pour analyser les images des documents

Obtenir la liste des documents de la transaction

Suppression des documents existants dans la transaction

Création d’un document au sein de la transaction

Téléversement des images capturées dans le document

Démarrage de la transaction

​Appels d’API par plateforme

​Plateforme iOS

​Plateforme Android

​Envoi des paramètres de session d’entrée au Vantage Mobile Upload Backend

​Paramètres de la session d’entrée

​Récupérer les paramètres de la session d’entrée depuis Vantage Mobile Upload Backend

​Paramètres de la session d’entrée

​Récupération du statut de la transaction

​Téléchargement des modèles pour analyser les images des documents

​Obtenir la liste des documents de la transaction

​Suppression des documents existants dans la transaction

​Création d’un document au sein de la transaction

​Téléversement des images capturées dans le document

​Démarrage de la transaction

Appels d’API par plateforme

Plateforme iOS

Plateforme Android

Envoi des paramètres de session d’entrée au Vantage Mobile Upload Backend

Paramètres de la session d’entrée

Récupérer les paramètres de la session d’entrée depuis Vantage Mobile Upload Backend

Paramètres de la session d’entrée

Récupération du statut de la transaction

Téléchargement des modèles pour analyser les images des documents

Obtenir la liste des documents de la transaction

Suppression des documents existants dans la transaction

Création d’un document au sein de la transaction

Téléversement des images capturées dans le document

Démarrage de la transaction