Passer au contenu principal
Vantage Mobile Upload communique avec le serveur Vantage par le biais d’appels à l’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 :
  1. Envoi des paramètres de la session de saisie au Vantage Mobile Upload Backend
  2. Récupération des paramètres de la session de saisie depuis le Vantage Mobile Upload Backend
  3. Récupération de l’état de la transaction
  4. Téléchargement de modèles pour analyser les images des documents
  5. Récupération de la liste des documents de la transaction
  6. Suppression des documents existants dans la transaction
  7. Création d’un document dans la transaction
  8. Téléversement des images capturées dans le document
  9. Démarrage de la transaction

​
Plateforme Android

La micro-application Android de Vantage Mobile Input utilise les appels d’API suivants :
  1. Récupération de l’état de la transaction
  2. Téléchargement de modèles pour l’analyse des images des documents
  3. Récupération de la liste des documents de la transaction
  4. Suppression des documents existants dans la transaction
  5. Création d’un document dans la transaction
  6. Téléchargement des images capturées dans le document
  7. Démarrage de la transaction

​
Envoi des paramètres de session d’entrée au backend de téléchargement mobile Vantage

Pour enregistrer le moment où l’utilisateur commence à capturer des documents et depuis quel appareil, utilisez POST /api/mobileinputbackend/v1/inputsessions. Cette ressource accepte les paramètres suivants :

​
Paramètres de session d’entrée

ParameterTypeDescription
transactionIdstring (uuid)Requis. Identifiant de la Transaction spécifié dans le lien de téléversement mobile.
platformstringRequis. Plateforme mobile de l’appareil où l’application micro est ouverte. Valeurs possibles : iOS, Android, Web.
deviceModelstringFacultatif. Modèle de l’appareil où l’application micro est ouverte.
OSVersionstringFacultatif. Version du système d’exploitation de l’appareil où l’application micro est ouverte.
MIVersionstringFacultatif. Version de Vantage Mobile Input utilisée par l’appareil.

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

Pour vérifier quand l’utilisateur a commencé à capturer des documents, utilisez GET /api/mobileinputbackend/v1/inputsessions/{transactionId}. Cette ressource renvoie les paramètres suivants :

​
Paramètres de session d’entrée

ParameterTypeDescription
transactionIdstring (uuid)Identifiant de Transaction spécifié dans le lien de téléversement mobile.
platformstringPlateforme mobile de l’appareil où la micro‑application est ouverte. Valeurs possibles : iOS, Android, Web.
deviceModelstringModèle de l’appareil où la micro‑application est ouverte.
OSVersionstringVersion du système d’exploitation de l’appareil où la micro‑application est ouverte.
MIVersionstringVersion de Vantage Mobile Input ouverte par l’appareil.
createdAtstring (date-time)Date et heure de création de la session d’entrée.

​
Obtenir l’état de la transaction

Pour vérifier l’état actuel de la transaction lors de la capture et du téléversement de documents, utilisez GET /api/publicapi/v1/transactions/{transactionId}. Cette ressource renvoie des informations sur la transaction, notamment :
  • transactionId. Identifiant unique de la transaction
  • status. État actuel de la transaction (New, Queued, InProgress, Processed, etc.)
  • createdAt. Date de création de la transaction
  • documents. Tableau des documents de la transaction

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

Pour télécharger les modèles de machine learning qui analysent les images de documents afin de détecter leur qualité et leur type, utilisez GET /api/mobileinputbackend/v1/models. Cet endpoint fournit des modèles qui aident l’application mobile à :
  • Détecter les contours du document
  • Vérifier la qualité de l’image
  • Identifier les types de documents
  • Valider les images capturées

​
Obtenir la liste des documents de la transaction

Pour récupérer tous les documents actuellement associés à la transaction, utilisez GET /api/publicapi/v1/transactions/{transactionId}/documents. Cette ressource renvoie un tableau d’objets document, chacun contenant :
  • id. Identifiant du document
  • name. Nom du document
  • status. Statut de traitement du document
  • files. Tableau de fichiers (images) associés au document

​
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 dans la transaction

Pour créer un nouveau document dans la transaction afin de téléverser des images, utilisez POST /api/publicapi/v1/transactions/{transactionId}/documents. Exemple de corps de requête : 
{
  "documents": [
    {
      "name": "Invoice",
      "index": 0
    }
  ]
}
Cela renvoie un ID de document qui sera utilisé pour charger des images.

​
Charger des images capturées dans le document

Pour charger des images capturées dans un document spécifique, utilisez POST /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}/sourceFiles. La requête doit inclure :
  • Des données de formulaire avec le(s) fichier(s) image
  • Des métadonnées facultatives pour chaque fichier
  • Des options de traitement d’image (autoCrop, autoOrientation)
Format de la requête :

​
Démarrage de la transaction

Pour lancer le traitement de tous les documents importés dans la transaction, utilisez POST /api/publicapi/v1/transactions/{transactionId}/start. Cette opération initie le flux de traitement avec le Skill spécifié lors de la création de la transaction. Exemple de requête : Après le démarrage :
  • L’état de la transaction passe à Queued ou InProgress
  • Les documents sont traités selon le Skill configuré
  • Les résultats deviennent disponibles lorsque l’état atteint Processed
  • Vous pouvez suivre la progression via le point de terminaison de statut de la transaction