Vai al contenuto principale
I file JSON contengono strutture dati che specificano il numero, i tipi e i nomi dei documenti, nonché il numero e i nomi delle pagine per ciascun documento. Per configurare il caricamento da mobile per gli scenari di uno specifico utente, usa il file JSON nel link di caricamento da mobile. Il parametro md può accettare un file JSON in due formati: link diretto codificato oppure JSON codificato. Per usare un link codificato:
  1. Genera un link di accesso diretto al file JSON.
Nota: Il link deve iniziare con “http://” o “https://”.
  1. Codifica il link ottenuto nel formato URL-encoded.
  2. Specifica l’URL codificato come valore del parametro md nel link di caricamento da mobile.
Per usare un JSON codificato:
  1. Codifica il file JSON nel formato URL-encoded.
  2. Specifica il file JSON codificato come valore del parametro md nel link di caricamento da mobile.

Struttura JSON

TransactionStructure definisce un set di documenti che l’utente deve acquisire durante una sessione di caricamento da mobile per l’elaborazione successiva in una transaction. La transaction non inizierà finché tutti i documenti non saranno stati acquisiti.
PropertiesValueDescription
version2.4La versione corrente di ABBYY Vantage. Nota: Il valore deve corrispondere al valore del parametro v nel link di caricamento da mobile.
elementsElementStructureLa struttura della raccolta di elementi.
ElementStructure definisce una raccolta composta da uno o più set di documenti che l’utente deve acquisire per l’elaborazione successiva in una transaction.
PropertiesValueDescription
typestandaloneDefinisce una raccolta con un solo set di documenti.
typesingle_choiceDefinisce una raccolta con più set di documenti. Nota: Richiede almeno due set di documenti specificati.
nameIl nome del set di documenti che verrà visualizzato nella schermata Capture Documents della micro‑applicazione. Nota: Disponibile solo per il tipo single_choice.
documentDocumentStructureLa struttura di un documento del set. Nota: Disponibile solo per il tipo standalone.
documentsDocumentStructureLa struttura di tutti i documenti del set. Nota: Disponibile solo per il tipo single_choice.
DocumentStructure definisce una raccolta di proprietà per ciascun documento nel set.
PropertiesValueDescription
typeidcardDefinisce l’acquisizione di entrambi i lati (fronte e retro) di una carta d’identità.
typepassportDefinisce l’acquisizione della prima pagina di un passaporto.
typedocumentDefinisce l’acquisizione di qualsiasi documento.
nameIl nome del documento che verrà visualizzato nella schermata Capture Documents della micro‑applicazione.
count1,2,3...Il numero richiesto di documenti da acquisire in una transaction. Il valore predefinito è “1”. Nota: Il caricamento non inizierà finché tutti i documenti non saranno stati acquisiti.
countanyIl numero di documenti da acquisire in una transaction. Nota: Il caricamento inizierà con qualsiasi numero di documenti acquisiti.
galleryEnabledfalse/trueIndica se è consentito caricare immagini delle pagine del documento dalla galleria del dispositivo per questo documento.
pagesPagesStructureLa struttura delle pagine del documento.
PagesStructure definisce una raccolta di proprietà per le pagine del documento che l’utente deve acquisire.
PropertiesValueDescription
nameFront side/Back sideI nomi delle pagine di una carta d’identità.
nameFirst page with photoIl nome della prima pagina di un passaporto.
nameDocument page nameI nomi delle pagine di qualsiasi documento.
count1,2,3...Il numero richiesto di pagine da acquisire per il documento. Il valore predefinito è “1”. Il caricamento non inizierà finché tutte le pagine del documento non saranno state acquisite. Nota: Il valore richiesto per fronte e retro di una carta d’identità è “1”.
countanyIl numero di pagine da acquisire per qualsiasi documento. Il caricamento inizierà con qualsiasi numero di pagine acquisite. Nota: Il valore richiesto per la prima pagina di un passaporto è “1”. Il valore richiesto per le altre pagine del passaporto è “any”.

Esempio di JSON

Ecco un esempio di struttura JSON per acquisire un numero specifico di documenti di passaporto con un numero predefinito di Pagine:
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "passport",
        "name": "Passaporto",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Prima pagina con foto",
            "count": 1
          },
          {
            "name": "Altre pagine",
            "count": "qualsiasi"
          }
        ]
      }
    }
  ]
}
Un esempio di struttura JSON per acquisire uno tra più documenti predefiniti:
{
  "version": "2.4",
  "elements": [
    {
      "type": "single_choice",
      "name": "Documento",
      "documents": [
        {
          "type": "idcard",
          "name": "Carta d'identità",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Fronte",
              "count": 1
            },
            {
              "name": "Retro",
              "count": 1
            }
          ]
        },
        {
          "type": "passport",
          "name": "Passaporto",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Prima pagina con foto",
              "count": 1
            },
            {
              "name": "Altre pagine",
              "count": "any"
            }
          ]
        }
      ]
    }
  ]
}
Esempio di struttura JSON per acquisire più documenti, con carta d’identità opzionale:
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "document",
        "name": "Fattura",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Pagina",
            "count": "qualunque"
          }
        ]
      }
    },
    {
      "type": "standalone",
      "document": {
        "type": "idcard",
        "name": "Carta d'identità",
        "count": "qualunque",
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Fronte",
            "count": 1
          },
          {
            "name": "Retro",
            "count": 1
          }
        ]
      }
    }
  ]
}