Passer au contenu principal
Les fichiers JSON contiennent des structures de données qui indiquent le nombre, les types et les noms des documents, ainsi que le nombre et les noms des pages pour chaque document. Pour configurer le téléversement mobile pour les scénarios d’un utilisateur donné, utilisez le fichier JSON dans le lien de téléversement mobile. Le paramètre md peut accepter un fichier JSON selon deux modalités : lien encodé direct ou JSON encodé. Pour utiliser un lien encodé :
  1. Générez un lien d’accès direct vers le fichier JSON.
Remarque : Le lien doit commencer par « http:// » ou « https:// ».
  1. Encodez le lien obtenu au format URL.
  2. Indiquez l’URL encodée comme valeur du paramètre md dans le lien de téléversement mobile.
Pour utiliser un JSON encodé :
  1. Encodez le fichier JSON au format URL.
  2. Indiquez le fichier JSON encodé comme valeur du paramètre md dans le lien de téléversement mobile.

​
Structure JSON

TransactionStructure définit un ensemble de documents que l’utilisateur doit capturer lors d’une session de téléversement mobile pour un traitement ultérieur dans une transaction. La transaction ne commencera pas tant que tous les documents n’auront pas été capturés.
PropertiesValueDescription
version2.4La version actuelle d’ABBYY Vantage. Remarque : La valeur doit correspondre à la valeur du paramètre v dans le lien de téléversement mobile.
elementsElementStructureLa structure de la collection d’éléments.
ElementStructure définit une collection d’un ou de plusieurs ensembles de documents que l’utilisateur doit capturer pour un traitement ultérieur dans une transaction.
PropertiesValueDescription
typestandaloneDéfinit une collection avec un seul ensemble de documents.
typesingle_choiceDéfinit une collection avec plusieurs ensembles de documents. Remarque : Nécessite au moins deux ensembles de documents spécifiés.
nameLe nom de l’ensemble de documents qui sera affiché sur l’écran Capture Documents dans la micro‑application. Remarque : Disponible uniquement pour le type single_choice.
documentDocumentStructureLa structure d’un document de l’ensemble. Remarque : Disponible uniquement pour le type standalone.
documentsDocumentStructureLa structure de tous les documents de l’ensemble. Remarque : Disponible uniquement pour le type single_choice.
DocumentStructure définit une collection de propriétés pour chaque document de l’ensemble.
PropertiesValueDescription
typeidcardDéfinit la capture des deux faces (recto et verso) d’une carte d’identité.
typepassportDéfinit la capture de la première page d’un passeport.
typedocumentDéfinit la capture de tout type de document.
nameLe nom du document qui sera affiché sur l’écran Capture Documents dans la micro‑application.
count1,2,3...Le nombre requis de documents à capturer dans une transaction. La valeur par défaut est « 1 ». Remarque : Le téléversement ne commencera pas tant que tous les documents n’auront pas été capturés.
countanyLe nombre de documents à capturer dans une transaction. Remarque : Le téléversement commencera avec n’importe quel nombre de documents capturés.
galleryEnabledfalse/trueIndique si le téléversement d’images des pages de document depuis la Galerie de l’appareil est autorisé pour ce document.
pagesPagesStructureLa structure des pages du document.
PagesStructure définit une collection de propriétés pour les pages du document que l’utilisateur doit capturer.
PropertiesValueDescription
nameFront side/Back sideLes noms des pages d’une carte d’identité.
nameFirst page with photoLe nom de la première page d’un passeport.
nameDocument page nameLes noms des pages de tout document.
count1,2,3...Le nombre requis de pages à capturer pour le document. La valeur par défaut est « 1 ». Le téléversement ne commencera pas tant que toutes les pages du document n’auront pas été capturées. Remarque : La valeur requise pour le recto et le verso d’une carte d’identité est « 1 ».
countanyLe nombre de pages à capturer pour tout document. Le téléversement commencera avec n’importe quel nombre de pages capturées. Remarque : La valeur requise pour la première page d’un passeport est « 1 ». La valeur requise pour les autres pages du passeport est « any ».

​
Exemple JSON

Exemple de structure JSON pour capturer un nombre spécifique de documents de passeport avec un nombre de Pages prédéfini : 
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "passport",
        "name": "Passeport",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Première page avec photo",
            "count": 1
          },
          {
            "name": "Autres pages",
            "count": "any"
          }
        ]
      }
    }
  ]
}
Exemple de structure JSON pour capturer l’un des documents prédéfinis : 
{
  "version": "2.4",
  "elements": [
    {
      "type": "single_choice",
      "name": "Document",
      "documents": [
        {
          "type": "idcard",
          "name": "Carte d’identité",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Recto",
              "count": 1
            },
            {
              "name": "Verso",
              "count": 1
            }
          ]
        },
        {
          "type": "passport",
          "name": "Passeport",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Première page avec photo",
              "count": 1
            },
            {
              "name": "Autres pages",
              "count": "any"
            }
          ]
        }
      ]
    }
  ]
}
Exemple de structure JSON pour capturer plusieurs documents avec, en option, une carte d’identité : 
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "document",
        "name": "Facture",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Page",
            "count": "any"
          }
        ]
      }
    },
    {
      "type": "standalone",
      "document": {
        "type": "idcard",
        "name": "Carte d’identité",
        "count": "any",
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Recto",
            "count": 1
          },
          {
            "name": "Verso",
            "count": 1
          }
        ]
      }
    }
  ]
}