Input JSON

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 dispositivo mobile per gli scenari di un determinato utente, utilizza 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 utilizzare un link codificato:

1. Genera un link di accesso diretto al file JSON.

Nota: Il link deve iniziare con “http://” o “https://”.

2. Codifica il link ottenuto nel formato URL codificato.
3. Specifica l’URL codificato come valore del parametro md nel link di caricamento da mobile.

Per utilizzare un JSON codificato:

1. Codifica il file JSON nel formato URL codificato.
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.

Properties	Value	Description
version	2.4	La versione corrente di ABBYY Vantage. Nota: Il valore deve corrispondere al valore del parametro v nel link di caricamento da mobile.
elements	ElementStructure	La 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.

Properties	Value	Description
type	standalone	Definisce una raccolta con un solo set di documenti.
type	single_choice	Definisce una raccolta con più set di documenti. Nota: Richiede almeno due set di documenti specificati.
name		Il nome del set di documenti che verrà visualizzato nella schermata Capture Documents della micro‑applicazione. Nota: Disponibile solo per il tipo single_choice.
document	DocumentStructure	La struttura di un documento del set. Nota: Disponibile solo per il tipo standalone.
documents	DocumentStructure	La 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.

Properties	Value	Description
type	idcard	Definisce l’acquisizione di entrambi i lati (fronte e retro) di una carta d’identità.
type	passport	Definisce l’acquisizione della prima pagina di un passaporto.
type	document	Definisce l’acquisizione di qualsiasi documento.
name		Il nome del documento che verrà visualizzato nella schermata Capture Documents della micro‑applicazione.
count	1,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.
count	any	Il numero di documenti da acquisire in una transaction. Nota: Il caricamento inizierà con qualsiasi numero di documenti acquisiti.
galleryEnabled	false/true	Indica se è consentito caricare immagini delle pagine del documento dalla galleria del dispositivo per questo documento.
pages	PagesStructure	La struttura delle pagine del documento.

PagesStructure definisce una raccolta di proprietà per le pagine del documento che l’utente deve acquisire.

Properties	Value	Description
name	Front side/Back side	I nomi delle pagine di una carta d’identità.
name	First page with photo	Il nome della prima pagina di un passaporto.
name	Document page name	I nomi delle pagine di qualsiasi documento.
count	1,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”.
count	any	Il 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
          }
        ]
      }
    }
  ]
}