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

​
Ottenere l’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 comando seguente: 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 e avviare una transaction

Per farlo, invia una richiesta POST alla risorsa transactions/launch: 
POST https://your-server/api/publicapi/v1/transactions/launch
Nel corpo della richiesta, specifica il parametro skillId, restituito dalla precedente chiamata API, e invia il file da elaborare. Un esempio di corpo della richiesta è il seguente: 
{
  "settings": {
    "skillId": "00000000-0000-0000-0000-000000000001"
  },
  "files": [
    {
      "file": "image content"
    }
  ]
}
Esegui il comando seguente: Per Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/launch" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"settings\": {
     \"skillId\": \"00000000-0000-0000-0000-000000000001\"
   },
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Per Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/launch' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "settings": {
     "skillId": "00000000-0000-0000-0000-000000000001"
   },
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'
Di conseguenza, riceverai una risposta contenente l’id della transaction creata.

​
Monitoraggio dello stato della transaction

Per farlo, invia una richiesta GET alla risorsa transactions: 
GET https://your-server/api/publicapi/v1/transactions/transaction-id
Esegui il comando seguente: 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 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.

​
Download dei file sorgente e dei file di risultato

Per scaricare il file sorgente, invia una richiesta GET alla risorsa transactions/files/download, specificando l’ID del file ricevuto nella richiesta precedente: 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download
Esegui il comando seguente: 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'