跳轉到主要內容
Vantage Mobile Upload 透過 API 呼叫與 Vantage 伺服器進行通訊。這些呼叫用於建立文件、上傳影像，以及以特定參數啟動處理作業。

​
iOS 平台

Vantage Mobile Input 的 iOS 微型應用程式會使用下列 API 呼叫：
  1. 將輸入工作階段的參數傳送至 Vantage Mobile Upload Backend
  2. 從 Vantage Mobile Upload Backend 取得輸入工作階段的參數
  3. 取得處理作業的狀態
  4. 下載用於分析文件影像的模型
  5. 取得處理作業中文件的清單
  6. 刪除處理作業中現有的文件
  7. 在處理作業中建立文件
  8. 將擷取的影像上傳至文件
  9. 啟動處理作業

​
Android 平台

Vantage Mobile Input 的 Android 微型應用程式使用以下 API 呼叫：
  1. 取得處理作業的狀態
  2. 下載用於分析文件影像的模型
  3. 取得處理作業中文件的清單
  4. 刪除處理作業中現有的文件
  5. 在處理作業中建立文件
  6. 將擷取的影像上傳至文件
  7. 啟動處理作業

​
將輸入工作階段參數傳送到 Vantage Mobile Upload Backend

若要記錄使用者何時開始擷取文件以及是從哪一個裝置擷取，請使用 POST /api/mobileinputbackend/v1/inputsessions。 此資源會接受下列參數：

​
輸入工作階段參數

ParameterTypeDescription
transactionIdstring (uuid)必填。行動上傳連結中指定的處理作業識別碼。
platformstring必填。用於開啟微型應用程式之裝置的行動平台。可能值：iOS、Android、Web。
deviceModelstring選填。用於開啟微型應用程式之裝置的機型。
OSVersionstring選填。用於開啟微型應用程式之裝置的作業系統版本。
MIVersionstring選填。裝置上開啟的 Vantage Mobile Input 版本。

​
從 Vantage Mobile Upload Backend 取得輸入工作階段的參數

若要查詢使用者何時開始擷取文件，請使用 GET /api/mobileinputbackend/v1/inputsessions/{transactionId}。 此資源會傳回下列參數：

​
輸入工作階段參數

ParameterTypeDescription
transactionIdstring (uuid)在行動上傳連結中指定的交易識別碼。
platformstring開啟微型應用程式之裝置的行動平台。可能的值：iOS、Android、Web。
deviceModelstring開啟微型應用程式之裝置的機型。
OSVersionstring開啟微型應用程式之裝置的作業系統版本。
MIVersionstring裝置所開啟的 Vantage Mobile Input 版本。
createdAtstring (date-time)建立輸入工作階段時的日期與時間。

​
取得處理作業的狀態

若要在擷取並上傳文件時檢查目前的處理作業狀態，請使用 GET /api/publicapi/v1/transactions/{transactionId}。 此資源會回傳關於處理作業的資訊，包括：
  • transactionId。處理作業的唯一識別碼
  • status。目前的處理作業狀態（New、Queued、InProgress、Processed 等）
  • createdAt。建立處理作業的時間
  • documents。處理作業中的文件陣列

​
下載用於分析文件影像的模型

若要下載用於分析文件影像品質與類型偵測的機器學習模型，請使用 GET /api/mobileinputbackend/v1/models。 此端點會提供模型，以協助行動應用程式：
  • 偵測文件邊界
  • 檢查影像品質
  • 辨識文件類型
  • 驗證拍攝的影像

​
取得該處理作業中的文件清單

若要取得目前與該處理作業關聯的所有文件，請使用 GET /api/publicapi/v1/transactions/{transactionId}/documents。 此資源會回傳一個文件物件的陣列，每個物件包含：
  • id。文件識別碼
  • name。文件名稱
  • status。文件處理狀態
  • files。與該文件關聯的影像檔案陣列

​
在處理作業中刪除現有文件

若要在開始處理之前從處理作業中移除某個文件，請使用 DELETE /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}。 這樣使用者可以：
  • 移除錯誤擷取的文件
  • 在重新擷取前清除文件
  • 管理處理作業中的文件集合
注意： 只能在處理作業開始處理之前刪除文件。

​
在處理作業中建立文件

若要在處理作業中建立新的文件用於上傳影像，請使用 POST /api/publicapi/v1/transactions/{transactionId}/documents。 要求本文範例： 
{
  "documents": [
    {
      "name": "Invoice",
      "index": 0
    }
  ]
}
這會回傳一個文件 ID，之後將用於上傳擷取的影像。

​
將擷取的影像上傳至文件

若要將擷取的影像上傳到特定文件，請使用 POST /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}/sourceFiles。 請求中必須包含：
  • 含有影像檔的表單資料
  • 每個檔案的可選中繼資料
  • 影像處理選項（autoCrop、autoOrientation）
請求格式：

​
啟動處理作業

若要開始處理該處理作業中所有已上傳的文件，請使用 POST /api/publicapi/v1/transactions/{transactionId}/start。 這會使用在建立處理作業時所指定的 skill 來啟動處理工作流程。 請求範例： 啟動之後：
  • 處理作業狀態會變更為 Queued 或 InProgress
  • 文件會依照已設定的 skill 進行處理
  • 當狀態變為 Processed 時，就可以取得結果
  • 您可以使用處理作業狀態端點追蹤進度