保利威文档中心

幫助中心

建立隔離區

更新時間:2022-09-02 18:08:07

介面說明

1、创建隔离区
2、接口支持https协议

介面URL


請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看

2、集團帳號介面計算簽名請使用集團主帳號的appId、appSecret

3、同一userId建立隔離區會拋出例外

請求參數說明

參數名 必填 類型 說明
appId true String 集團主帳號appId
timestamp true Long 目前13位毫秒級時間戳,3分鐘內有效
userId true String 使用者全域ID,即userId
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則

範例


回應參數說明

參數名 類型 說明
code Integer 狀態碼,與http狀態碼相同,用於確定基本的回應狀態
status String 回應結果,由業務決定,成功回傳success,失敗回傳error
success Boolean 是否成功回應
requestId String 請求ID,每次請求產生的唯一UUID,僅可用於排查、除錯,不應與業務掛鉤
error Object 狀態碼非200時的錯誤資訊【詳見Error欄位說明
data Object 【詳見data欄位說明

Error參數說明

參數名 類型 說明
code Integer 錯誤代碼,用於確定具體的錯誤原因
desc String 錯誤描述,與error.code對應

Data參數說明

參數名 類型 說明
isolationId String 隔離區ID

Java請求範例


回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例


異常範例

{
    "code": 400,
    "status": "error",
    "error": {
        "code": 10003,
        "desc": "时间戳过期"
    },
    "success": false
}
联系客服,在线咨询