如何使用

存取金鑰

API使用存取金鑰進行身份驗證。訪問您的存取金鑰頁面以檢索您在請求中將使用的存取金鑰。 輸入您的用戶名（註冊郵件）和密碼，登錄系統。

身份驗證

請記住，您的存取金鑰是一個秘密！不要與他人分享它，也不要在任何客戶端代碼（瀏覽器、應用程序）中公開它。生產請求必須通過您自己的後端伺服器路由，其中您的存取金鑰可以從環境變數或金鑰管理服務中安全載入。

所有API請求應該在授權HTTP標頭中包括您的API金鑰，如下所示：

Authorization: Bearer DOCAI_API_KEY

響應主體

Name	Type	Mandatory	Description
code	integer	true	請求響應代碼，返回200表示請求成功。詳細信息請參閱回應代碼章節
message	string	false	請求失敗的原因，只有在代碼不等於200時才會有值
requestId	string	true	請求序列號
currentTimeMillis	long	true	請求時間戳，自1970-01-01以來的毫秒數
data	object or array	false	請求對應的結果，可以是對象或對象數組

發送請求

您可以將以下命令粘貼到終端中以運行您的第一個API請求。請確保將$DOCAI_API_KEY替換為您的秘密API金鑰。

curl -i -X GET https://api.docai.pro/api/model/info/v2/listCreateByMeModels \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $DOCAI_API_KEY"

此請求查詢您有權調用的產品。您應該收到一個類似以下的響應：

{
    "code": 200,
    "message": null,
    "costTime": null,
    "data": [
        {
            "modelId": "e15f9f3adf3b421ab6d91fabe4ac3d65",
            "modelName": "Invoice Model",
            "description": "description",
            "createTime": 1692792479000,
            "updateTime": 1695069965000
        }
    ],
    "requestId": "a3d513902f554e2d842321d71b9102b6",
    "currentTimeMillis": 1695280438196
}