MAXScanner API v1
打造文件工作流程,而不是處理基礎架構。
以非同步為優先的 API,涵蓋文件、檔案、OCR、轉換、PDF、壓縮與 Webhook。統一的驗證模型、統一的工作生命週期與統一的結果契約。
驗證
限定範圍的 API 金鑰
處理
非同步工作
事件
簽章 Webhook
參考
所有 API 操作
POST
/api/v1/jobs建立處理工作
提交非同步處理操作,並取得穩定的工作識別碼。
GET
/api/v1/jobs/{jobId}取得工作狀態
讀取處理工作目前的生命週期狀態與結果資訊。
GET
/api/v1/documents列出文件
列出已驗證帳戶可用的文件。
POST
/api/v1/documents/{documentId}/process處理文件
為帳戶中的某個文件版本建立非同步處理工作。
POST
/api/v1/files/upload授權檔案上傳
為私人來源檔案建立有上限的上傳流程。
POST
/api/v1/convert轉換檔案
將支援的文件轉換導向受管理的處理器群組。
POST
/api/v1/ocr執行 OCR
從支援的圖片或文件擷取可搜尋的文字。
POST
/api/v1/pdf執行 PDF 操作
提交支援的 PDF 操作,例如合併、分割或最佳化。
POST
/api/v1/compress壓縮圖片
提交帶有格式與品質條件的圖片最佳化工作。
POST
/api/v1/webhooks建立 Webhook
為工作與文件事件註冊附簽章的回呼目的地。
GET
Error reference錯誤參考
了解驗證、檢核、配額、衝突與伺服器錯誤。
GET
Limits & formats上限與格式
查看支援的格式、配額與請求限制。