保利威文档中心

幫助中心

重設子帳號應用密鑰

更新時間:2022-09-21 18:29:03

介面說明

1、重置分账号应用密匙
2、(timestamp, appId, sign)签名参数需通过url传递
3、接口支持https协议

介面URL

http://api.polyv.net/live/v4/group/user/secret/reset

請求方式

POST

介面限制

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

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

3、應用密鑰重設後5分鐘生效

請求參數說明

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

範例

http://api.polyv.net/live/v4/group/user/secret/reset?appId=ga1ayl6dh2&timestamp=1661443279000&sign=FD154894135E713FC2D0D64B2B33E72E&email=paasgrouptestpre01@polyv.net

回應參數說明

參數名 類型 說明
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參數說明

參數名 類型 說明
appId String 應用ID
appSecret String 重設後的應用Secret
userId String 使用者全域ID

Java請求範例

private static final Logger log = LoggerFactory.getLogger(GroupTestLive.class);
/**
 * 重置分账号应用密匙
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void groupSecretResetTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.groupAppId;
    String appSecret = super.groupAppSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/group/user/secret/reset";
    String email = "";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("email", email);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postFormBody(url, null);
    log.info("测试重置分账号应用密匙成功:{}", response);
    //do somethings
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "6c8c2d016ace4366a0d8fe2ff632ba28.72.16614432795402597",
    "data": {
        "appId": "gcx4zavev0",
        "appSecret": "50bxxxxxxxxxxxx68157635",
        "userId": "eaf4fead20"
    },
    "success": true
}

異常範例

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