註冊開發者並獲取 API Key
提供用於文件翻譯的RESTful API，支援自動化翻譯任務管理、基於術語表的術語一致性，以及對支援格式、語言和模型的查詢，便於建構無縫翻譯工作流程和管理使用者帳戶。
入門指南
要開始使用，您需要申請成為開發者。申請成為開發者
一旦獲得覈准，您可以建立多個API金鑰，並根據需要在每個API請求中包含相應的API金鑰。
快速接入
基礎 URL
https://shangyiai.com/api
認證方式
Authorization: [yourSecretKey]
JSON 請求
除文件上傳接口外，接口默認使用 POST JSON 請求，Content-Type 為 application/json。
檔案上傳
建立文件翻譯任務使用 multipart/form-data，file 欄位傳入待翻譯檔案。
通用錯誤響應
請求失敗時介面會返回 JSON，error 欄位包含固定英文錯誤訊息。建議優先按 HTTP status code 分支處理錯誤，error 欄位用於展示或日誌記錄。
{
"error": "Invalid API key."
}錯誤狀態碼規則
所有 v1 API 錯誤響應保持相同結構，請按下列 HTTP status code 規則處理。
- 400 Bad Request
- 缺少必需參數、參數格式或枚舉值無效、缺少檔案上傳、上傳儲存失敗或任務處理失敗。
- 401 Unauthorized
- 缺少 API 金鑰或 API 金鑰無效。
- 402 Payment Required
- 積分餘額不足，無法進行預覽、完整翻譯或文本翻譯。
- 404 Not Found
- 該任務或術語表不存在、已被刪除、不屬於當前API帳戶，或者不是通過API創建的。
- 409 Conflict
- 當前任務狀態不允許請求的操作。
- 500 Internal Server Error
- 意外的伺服器異常。回應錯誤固定為「內部伺服器錯誤」。
推薦接入流程
1. 建立任務
上傳檔案並建立翻譯任務，返回 taskId。
2. 查詢進度
輪詢任務狀態，直到 Completed、Terminated 或 Cancelled。
3. 獲取結果
下載譯文檔案，或讀取原文和譯文 JSON。
4. 管理任務
按需支付全文翻譯、重啟任務、修訂文本或刪除任務。