Vai al contenuto principale
Uno scenario tipico per l’elaborazione dei documenti tramite una singola chiamata API (per creare una transaction, caricare un file e avviare la transaction) prevede i seguenti passaggi:
  1. Ricevere l’elenco di tutte le skill disponibili.
  2. Creare e avviare una transaction.
  3. Monitorare lo stato della transaction.
  4. Scaricare i file sorgente e i file dei risultati.
Ogni richiesta inviata al server deve includere le informazioni di autenticazione. Per ulteriori informazioni, vedere Autenticazione. Utilizzare questo scenario se si dispone di un solo file con dimensioni inferiori a 30 MB e non è necessario modificare le immagini del file.

​
Passaggio 1. Ottenere l’elenco di tutte le skill disponibili

Per ottenere l’elenco di tutte le skill disponibili, invia una richiesta GET alla risorsa skills: Esegui il comando seguente: Di conseguenza, riceverai informazioni su tutte le skill aggiunte all’istanza dell’applicazione.

​
Passaggio 2. Creare e avviare una transaction

Per creare e avviare una transaction, invia una richiesta POST alla risorsa transactions/launch: Nell’URL specifica il parametro di query skillId (restituito dalla precedente chiamata API). Nel corpo invia il file da elaborare insieme a metadati opzionali. Puoi anche passare i registrationParameters e i skillParameters opzionali nel corpo della richiesta. Di seguito è riportato un esempio di corpo della richiesta: 
{
  "files": [
    {
    }
  ]
}
Esegui il seguente comando: Riceverai quindi una risposta che contiene l’id della transaction creata.

​
Passaggio 3. Monitoraggio dello stato della transaction

Per monitorare lo stato della transaction, invia una richiesta GET alla risorsa transactions: Esegui il comando seguente: Di conseguenza, riceverai una risposta contenente lo stato della transaction. L’elaborazione della transaction può trovarsi in uno dei seguenti stati:
  • New. La transaction è stata creata ma non è ancora stata messa in coda per l’elaborazione.
  • Queued. La transaction è in coda per l’elaborazione.
  • InProgress. La transaction è in fase di elaborazione.
  • Processed. La transaction è stata elaborata correttamente.
  • ProcessedWithWarnings. La transaction è stata elaborata, ma si sono verificati avvisi.
  • NotProcessed. La transaction non è stata elaborata a causa di un errore.
  • Deleted. La transaction è stata eliminata dall’utente o automaticamente in base ai criteri di conservazione.
Se lo stato della transaction è Processed o ProcessedWithWarnings, passa al punto 4.

​
Passaggio 4. Download dei file sorgente e dei file di risultato

Per scaricare i file sorgente e i file di risultato, invia una richiesta GET alla risorsa transactions/files/download, specificando l’ID del file, ricevuto nella richiesta precedente: Esegui il comando seguente: