跳轉到主要內容
透過個別的 API 呼叫 (用於建立處理作業、上傳檔案及啟動處理作業) 來處理文件的典型情境包括以下步驟：
  1. 取得所有可用技能的清單
  2. 建立一個空的處理作業
  3. 將一組要在處理作業中處理的檔案加入其中
  4. 啟動處理作業
  5. 監控處理作業狀態
  6. 下載來源檔案與結果檔案
向伺服器發出的每個請求都必須包含驗證資訊 (例如存取權杖 access token) 。如需更多資訊，請參閱 Authentication。

​
取得所有可用技能清單

為此，請向 skills 資源傳送 GET 要求： 執行下列指令： 如此一來，您將取得已新增至此應用程式執行個體的所有技能資訊。

​
建立空白處理作業

請向 transactions 資源發送以下 POST 請求： 執行以下指令： 在請求本文中指定先前 API 呼叫所傳回的 skillId 參數。完成後，您會收到一個回應，其中包含已建立處理作業的 id。

​
在處理作業中新增一組要處理的檔案

重要！ 一個處理作業中最多可以包含 1000 個檔案。 您可以透過兩種方式新增一組檔案：

​
直接將檔案新增到交易中

請向 transactions/<transaction-id>/files 資源發送 POST 請求： 執行以下指令： 系統會回傳一個回應，其中包含已新增檔案及其識別碼的清單。您可以依需求多次重複此呼叫，以新增任意數量的檔案。 上傳檔案的其他選項：

​
向文件新增檔案

首先，透過向 transactions/<transaction-id>/documents 資源發送 POST 請求來建立一個文件： 此操作會回傳包含文件識別碼的回應。 接著，透過向 transactions/<transaction-id>/documents/<document-id>/sourceFiles 資源發送 POST 請求，將檔案新增至該文件：

​
開始處理作業

若要使用指定的 skill 和檔案開始處理作業，請將下列 POST 要求傳送到 transactions/<transaction-id>/start 資源：

​
監控處理作業狀態

若要開始使用具有短逾時時間的迴圈來監控處理作業狀態 (我們不建議狀態檢查頻率高於每秒一次) ，請對 transactions/<transaction_id> 資源送出 GET 要求，並在要求 URI 中包含處理作業識別碼： 如此一來，您會收到包含處理作業狀態的回應。處理作業可能處於下列其中一種狀態：
  • New。已建立處理作業，但尚未排入佇列進行處理。
  • Queued。處理作業已排入佇列，準備進行處理。
  • InProgress。處理作業正在處理中。
  • Processed。處理作業已成功處理。
  • ProcessedWithWarnings。處理作業已處理完成，但發生警告。
  • NotProcessed。由於錯誤，處理作業未被處理。
  • Deleted。處理作業已由使用者或依據保存原則自動刪除。
如果處理作業狀態為 Processed 或 ProcessedWithWarnings，請前往步驟 6。

​
下載來源檔案

若要取得包含文件識別碼的文件清單，請對 transactions/<transaction-id>/documents 資源送出 GET 要求，並指定交易識別碼： 成功呼叫後，您會收到在此交易中建立的所有文件清單。回應同時包含這些文件的識別碼，後續如需請求特定文件的詳細資訊時可能會用到。 若要取得已新增到特定文件的檔案清單，請對 transactions/<transaction-id>/documents/<document-id> 資源送出 GET 要求： 成功呼叫後，您會收到該文件的相關資訊。回應同時包含新增到此文件之檔案的識別碼。 若要下載來源檔案，請對 transactions/<transaction-id>/files/<file-id>/download 資源送出 GET 要求：