設定單點登入 token
更新時間:2023-11-14 14:07:19
介面 URL
https://api.polyv.net/live/v2/channels/{channelId}/set-token
介面說明
1、設定頻道單點登入的 token
2、介面支援 https 協定
3、介面 URL 中的 {channelId} 為 頻道 ID
支援格式
JSON
請求方式
GET, POST
請求數限制
TRUE
請求參數
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | 是 | string | 從 API 設定中取得,在直播系統登記的 appId |
| timestamp | 是 | string | 目前 13 位毫秒級時間戳,3 分鐘內有效 |
| token | 是 | string | 唯一的字串 |
| sign | 是 | String | 簽名,為 32 位大寫的 MD5 值,產生簽名的 appSecret 金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有 API 都必須透過客戶自己伺服器中轉呼叫 POLYV 伺服器取得回應資料【詳見簽名產生規則】 |
回應成功 JSON 範例:
{
"code": 200,
"status": "success",
"message": "",
"data": "success"
}
回應失敗 JSON 範例:
未輸入 appId
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
appId 不正確
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
時間戳錯誤
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
簽名錯誤
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
欄位說明
| 參數名 | 說明 |
|---|---|
| code | 請求狀態回應碼 |
| status | 請求狀態 |
| message | 錯誤訊息 |
| data | 成功時回傳,success |
php 請求範例
<?php
//引用config.php
include 'config.php';
//接口需要的参数(非sign)赋值
$channelId = "127075";
$token = "skudjjdkkkkk";
$params = array(
'appId'=>$appId,
'token'=>$token,
'timestamp'=>$timestamp
);
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
//接口请求url
$url = "https://api.polyv.net/live/v2/channels/$channelId/set-token?appId=$appId×tamp=$timestamp&token=$token&sign=$sign";
//输出接口请求结果
echo file_get_contents($url);
?>
