Vai al contenuto principale
Vantage Mobile Upload comunica con il server Vantage tramite chiamate API. Queste chiamate vengono usate per creare documenti, caricare immagini e avviare l’elaborazione delle transaction con determinati parametri.

​
Piattaforma iOS

La micro-applicazione iOS di Vantage Mobile Input utilizza le seguenti chiamate API:
  1. Invio dei parametri della sessione di input al Vantage Mobile Upload Backend
  2. Recupero dei parametri della sessione di input dal Vantage Mobile Upload Backend
  3. Recupero dello stato della transaction
  4. Download dei modelli per l’analisi delle immagini dei documenti
  5. Recupero dell’elenco dei documenti nella transaction
  6. Eliminazione dei documenti esistenti nella transaction
  7. Creazione di un document nella transaction
  8. Caricamento delle immagini acquisite nel document
  9. Avvio della transaction

​
Piattaforma Android

La microapp Android di Vantage Mobile Input utilizza le seguenti chiamate API:
  1. Recupero dello stato della transaction
  2. Download dei modelli per l’analisi delle immagini dei documenti
  3. Recupero dell’elenco dei documenti nella transaction
  4. Eliminazione dei documenti esistenti nella transaction
  5. Creazione di un documento nella transaction
  6. Upload delle immagini acquisite nel documento
  7. Avvio della transaction

​
Invio dei parametri della sessione di input al backend di caricamento mobile di Vantage

Per registrare quando l’utente avvia l’acquisizione dei documenti e da quale dispositivo, usare POST /api/mobileinputbackend/v1/inputsessions. Questa risorsa accetta i seguenti parametri:

​
Parametri della sessione di input

ParameterTypeDescription
transactionIdstring (uuid)Obbligatorio. Identificatore della Transaction specificato nel link di caricamento da dispositivo mobile.
platformstringObbligatorio. La piattaforma del dispositivo su cui è aperta la microapplicazione. Valori possibili: iOS, Android, Web.
deviceModelstringFacoltativo. Modello del dispositivo su cui è aperta la microapplicazione.
OSVersionstringFacoltativo. Versione del sistema operativo del dispositivo su cui è aperta la microapplicazione.
MIVersionstringFacoltativo. Versione di Vantage Mobile Input in uso sul dispositivo.

​
Recuperare i parametri della sessione di input dal backend di caricamento mobile di Vantage

Per verificare quando l’utente ha iniziato ad acquisire i documenti, usare GET /api/mobileinputbackend/v1/inputsessions/{transactionId}. Questa risorsa restituisce i seguenti parametri:

​
Parametri della sessione di input

ParameterTypeDescription
transactionIdstring (uuid)Identificatore della Transaction specificato nel link di caricamento da mobile.
platformstringLa piattaforma mobile del dispositivo su cui è aperta la microapplicazione. Valori possibili: iOS, Android, Web.
deviceModelstringIl modello del dispositivo su cui è aperta la microapplicazione.
OSVersionstringLa versione del sistema operativo del dispositivo su cui è aperta la microapplicazione.
MIVersionstringLa versione di Vantage Mobile Input aperta dal dispositivo.
createdAtstring (date-time)Data e ora di creazione della sessione di input.

​
Recuperare lo stato della transaction

Per verificare lo stato corrente della transaction durante l’acquisizione e il caricamento dei documenti, usa GET /api/publicapi/v1/transactions/{transactionId}. Questa risorsa restituisce informazioni sulla transaction, tra cui:
  • transactionId. Identificatore univoco della transaction
  • status. Stato corrente della transaction (New, Queued, InProgress, Processed, ecc.)
  • createdAt. Data e ora di creazione della transaction
  • documents. Array di documenti nella transaction

​
Download dei modelli per l’analisi delle immagini dei documenti

Per scaricare i modelli di machine learning che analizzano le immagini dei documenti per il rilevamento della qualità e del tipo, usa GET /api/mobileinputbackend/v1/models. Questo endpoint fornisce modelli che aiutano l’app mobile a:
  • Rilevare i contorni del documento
  • Verificare la qualità dell’immagine
  • Identificare i tipi di documento
  • Convalidare le immagini acquisite

​
Ottenere l’elenco dei documenti nella transaction

Per recuperare tutti i documenti attualmente associati alla transaction, usa GET /api/publicapi/v1/transactions/{transactionId}/documents. Questa risorsa restituisce un array di oggetti documento, ciascuno dei quali contiene:
  • id. Identificatore del documento
  • name. Nome del documento
  • status. Stato di elaborazione del documento
  • files. Array di file (immagini) associati al documento

​
Eliminazione dei documenti esistenti nella transaction

Per rimuovere un documento dalla transaction prima di avviare l’elaborazione, usa DELETE /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}. Questo permette di:
  • Rimuovere i documenti acquisiti in modo errato
  • Svuotare i documenti prima di riacquisirli
  • Gestire i set di documenti nella transaction
Nota: I documenti possono essere eliminati solo prima che la transaction inizi l’elaborazione.

​
Creazione di un documento nella transaction

Per creare un nuovo documento nella transaction per caricare immagini, usa POST /api/publicapi/v1/transactions/{transactionId}/documents. Esempio di corpo della richiesta: 
{
  "documents": [
    {
      "name": "Fattura",
      "index": 0
    }
  ]
}
Questo restituisce un ID del documento che verrà utilizzato per caricare le immagini.

​
Caricamento delle immagini acquisite nel documento

Per caricare immagini acquisite in uno specifico documento, usa POST /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}/sourceFiles. La richiesta deve includere:
  • Dati del form con i file immagine
  • Metadati opzionali per ciascun file
  • Opzioni di elaborazione delle immagini (autoCrop, autoOrientation)
Formato della richiesta: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Files=@image1.jpg;type=image/jpeg" \
-F "Files=@image2.jpg;type=image/jpeg"

​
Avvio della transaction

Per avviare l’elaborazione di tutti i documenti caricati nella transaction, utilizzare POST /api/publicapi/v1/transactions/{transactionId}/start. Questo avvia il flusso di elaborazione con la skill specificata al momento della creazione della transaction. Esempio di richiesta: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/start" \
-H "Authorization: Bearer token"
Dopo l’avvio:
  • Lo stato della Transaction passa a Queued o InProgress
  • I Document vengono elaborati in base alla skill configurata
  • I risultati diventano disponibili quando lo stato raggiunge Processed
  • Puoi monitorare l’avanzamento usando l’endpoint dello stato della Transaction