Vai al contenuto principale
Uno scenario tipico per l’elaborazione dei documenti tramite chiamate API separate (per creare una transaction, caricare un file e avviare una transaction) prevede i seguenti passaggi:
  1. Ricezione dell’elenco di tutte le skill disponibili
  2. Creazione di una transaction vuota
  3. Aggiunta di un set di file da elaborare nella transaction
  4. Avvio della transaction
  5. Monitoraggio dello stato della transaction
  6. Download dei file di origine e dei file di risultato
Ogni richiesta al server deve includere le informazioni di autenticazione (ad esempio un token di accesso). Per ulteriori informazioni, vedere Authentication.

​
Ottenere un elenco di tutte le skill disponibili

Per farlo, invia una richiesta GET alla risorsa skills: 
GET https://your-server/api/publicapi/v1/skills
Esegui il seguente comando: Per Windows: 
curl -X GET "https://your-server/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"
Per Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'
Di conseguenza, riceverai informazioni su tutte le skill aggiunte all’istanza dell’applicazione.

​
Creare una transaction vuota

Per farlo, invia la seguente richiesta POST alla risorsa transactions: 
POST https://your-server/api/publicapi/v1/transactions
Esegui il comando seguente: Per Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{
  \"skillId\": \"00000000-0000-0000-0000-000000000001\"
}"
Per Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
  "skillId": "00000000-0000-0000-0000-000000000001"
}'
Nel body della richiesta, specifica il Parameter skillId restituito dalla chiamata API precedente. Come risultato, riceverai una risposta contenente l’id della transaction creata.

​
Aggiunta di un set di file da elaborare nella transaction

Importante! Il numero massimo di file in una transaction è 1000. Un set di file può essere aggiunto in due modi:

​
Aggiunta di file direttamente alla transaction

Per farlo, invia una richiesta POST alla risorsa transactions/<transaction-id>/files: 
POST https://your-server/api/publicapi/v1/transactions/transaction-id/files
Nel corpo della richiesta, inviare il file da elaborare. Per i dettagli sui Parameter disponibili per personalizzare i file, vedere l’API Reference. Eseguire il comando seguente: Per Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/files" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Per Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/files' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'
Di conseguenza, riceverai una risposta con l’elenco dei file aggiunti e dei loro identificatori. Puoi aggiungere quanti file desideri ripetendo questa chiamata più volte. Opzioni aggiuntive per il caricamento dei file:

​
Aggiunta di file a un documento

Per prima cosa, crea un documento inviando una richiesta POST alla risorsa transactions/<transaction-id>/documents: 
POST https://your-server/api/publicapi/v1/transactions/transaction-id/documents
Per Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{
  \"documents\": [
    {
    }
  ]
}"
Per Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
  "documents": [
    {
    }
  ]
}'
Di conseguenza, riceverai una risposta con l’identificatore del documento. Quindi aggiungi i file al documento inviando una richiesta POST alla risorsa transactions/<transaction-id>/documents/<document-id>/sourceFiles: 
POST https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles
Per Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Per Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'

​
Avvio della Transaction

Per avviare la Transaction con la skill e i file specificati, inviare la seguente richiesta POST alla risorsa transactions/<transaction-id>/start: 
POST https://your-server/api/publicapi/v1/transactions/transaction-id/start
Per Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/start" \
-H "accept: */*" \
-H "Authorization: Bearer token"
Per Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/start' \
-H 'accept: */*' \
-H 'Authorization: Bearer token'

​
Monitorare lo stato della transaction

Per monitorare lo stato della transaction utilizzando un ciclo con un breve timeout (sconsigliamo di controllare lo stato più di una volta al secondo), invia una richiesta GET alla risorsa transactions/<transaction_id> includendo l’identificatore della transaction nell’URI della richiesta: 
GET https://your-server/api/publicapi/v1/transactions/transaction-id
Per Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"
Per Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'
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 degli avvisi.
  • NotProcessed. La transaction non è stata elaborata a causa di un errore.
  • Deleted. La transaction è stata eliminata dall’utente o automaticamente secondo i criteri di conservazione.
Se lo stato della transaction è Processed o ProcessedWithWarnings, vai al passaggio 6.

​
Download dei file sorgente

Per ottenere un elenco di documenti con i relativi identificatori, invia una richiesta GET alla risorsa transactions/<transaction-id>/documents e specifica l’identificatore della transaction: 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/documents
Per Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/documents" \
-H "Authorization: Bearer token"
Per Linux: 
curl -X GET 'https://tuo-server/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'Autorizzazione: Bearer token'
Di conseguenza, riceverai un elenco di tutti i documenti creati all’interno di questa transaction. La risposta contiene anche gli identificatori di questi documenti, che potrebbero servirti per richiedere informazioni dettagliate su documenti specifici. Per ottenere l’elenco dei file aggiunti a un documento specifico, invia una richiesta GET alla risorsa transactions/<transaction-id>/documents/<document-id>: 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id
Per Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id" \
-H "Authorization: Bearer token"
Su Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id' \
-H 'Authorization: Bearer token'
Di conseguenza, riceverai informazioni sul documento. La risposta include anche gli identificatori dei file aggiunti al documento. Per scaricare il file di origine, invia una richiesta GET alla risorsa transactions/<transaction-id>/files/<file-id>/download: 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download
Per Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"
Per Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'