接口規(guī)范 8. 播出認(rèn)證相關(guān)接口

發(fā)布時(shí)間：2020-07-27 14:59:37 來(lái)源：網(wǎng)絡(luò) 閱讀：682 作者：sendoffice 欄目：開(kāi)發(fā)技術(shù)

8 播出認(rèn)證相關(guān)接口

8.1.開(kāi)啟播出認(rèn)證

用途
針對(duì)某個(gè)應(yīng)用，開(kāi)啟播出認(rèn)證。
開(kāi)啟播出認(rèn)證后，所有播放該應(yīng)用下的視頻流的請(qǐng)求都需要做合法性認(rèn)證，只有認(rèn)證通過(guò)的請(qǐng)求才會(huì)允許播放。
認(rèn)證的方法包括token認(rèn)證、referer認(rèn)證和第三方認(rèn)證。
token認(rèn)證，就是為每個(gè)播出流配置一個(gè)認(rèn)證碼(token)，播放終端只有獲得該認(rèn)證碼，并將該認(rèn)證碼作為播出請(qǐng)求的參數(shù)提交，才能夠正常播放視頻。
referer認(rèn)證，就是要求播放終端必須從某個(gè)域名下的網(wǎng)站發(fā)起播放請(qǐng)求，也就是只有將播出視頻嵌入到某個(gè)指定域名下的網(wǎng)站才允許播放。
第三方認(rèn)證，就是將認(rèn)證請(qǐng)求轉(zhuǎn)交給第三方系統(tǒng)的服務(wù)接口去認(rèn)證，認(rèn)證通過(guò)后才允許播放。開(kāi)啟第三方認(rèn)證后，所有本地認(rèn)證策略會(huì)被忽略。
請(qǐng)求
authMgr/?request=open_play_auth&application=liveshow
application 應(yīng)用名
響應(yīng)
```
{
"code":0
}
```

8.2.關(guān)閉播出認(rèn)證

用途
針對(duì)某個(gè)應(yīng)用，關(guān)閉播出認(rèn)證。關(guān)閉后播放該應(yīng)用下的視頻流不需要做認(rèn)證。
請(qǐng)求
authMgr/?request=close_play_auth&application=liveshow
application 應(yīng)用名
響應(yīng)
```
{
"code":0
}
```

8.3.開(kāi)啟和關(guān)閉播出token認(rèn)證

用途
針對(duì)某個(gè)應(yīng)用，開(kāi)啟和關(guān)閉播出token認(rèn)證方式。
設(shè)置該參數(shù)是為了迎合僅使用referer認(rèn)證情況。
請(qǐng)求
authMgr/?request=open_play_token&application=liveshow&open=1
application 應(yīng)用名
open 是否開(kāi)啟認(rèn)證，open=1表示開(kāi)啟認(rèn)證，open=0表示關(guān)閉認(rèn)證
響應(yīng)
```
{
"code":0
}
```

8.4.查詢播出token

用途
查詢某個(gè)應(yīng)用下播出認(rèn)證token的列表。
每個(gè)token設(shè)置到一個(gè)視頻流上，播放客戶端訪問(wèn)該視頻流需要給出正確的token值。
請(qǐng)求
authMgr/?request=list_play_token&application=liveshow
application 應(yīng)用名

響應(yīng)

{
"code":0,
"data":{
    "count":1,
    "items":[
        {
            "application":"liveshow",
            "stream":"live1",
            "token":"8501E93883FC4D14",
            "use_once":0
        }
    ]
}
}

items元素包含當(dāng)前應(yīng)用下的token定義。
application 應(yīng)用名
stream 流名稱
token token值

8.5.添加播出token

用途
為視頻流添加播出認(rèn)證token。
每個(gè)token設(shè)置到一個(gè)視頻流上，播放客戶端訪問(wèn)該視頻流需要給出正確的token值。
請(qǐng)求
authMgr/?request=add_play_token&application=liveshow&stream=live1&token_val=8501E93883FC4D14
application 應(yīng)用名
stream 流名稱
token_val 添加的token值（注意這里使用token_val參數(shù)名，避免與接口認(rèn)證的token參數(shù)沖突）
響應(yīng)
```
{
"code":0
}
```

8.6.刪除播出token

用途
刪除某個(gè)視頻流的token。
請(qǐng)求
authMgr/?request=delete_play_token&application=liveshow&stream=live1
application 應(yīng)用名
stream 流名稱
響應(yīng)
```
{
"code":0
}
```

8.7.設(shè)置播出認(rèn)證的referer值

用途
為某個(gè)應(yīng)用設(shè)置播出認(rèn)證referer值。
請(qǐng)求
authMgr/?request=set_referer&application=liveshow&url=play.ruiboyun.net;cloud.ruiboyun.net
application 應(yīng)用名
url 允許訪問(wèn)的域名列表，多個(gè)域名之間使用半角分號(hào)隔開(kāi)。如果要撤銷referer認(rèn)證，將url設(shè)為空即可。
響應(yīng)
```
{
"code":0
}
```

8.8.設(shè)置第三方播出認(rèn)證地址

用途
將某個(gè)應(yīng)用下的播出認(rèn)證地址設(shè)置為一個(gè)第三方認(rèn)證地址。
設(shè)置第三方認(rèn)證地址后，所有本地認(rèn)證策略失效。
如果要取消第三方認(rèn)證，將url參數(shù)設(shè)置為空即可。
請(qǐng)求
authMgr/?request=set_play_auth_url&application=liveshow&url=http://i.ruiboyun.net/interface
application 應(yīng)用名
url 第三方認(rèn)證接口的url地址，本參數(shù)需要進(jìn)行【URL編碼】。
響應(yīng)
```
{
"code":0
}
```

8.9.查詢播出和推流認(rèn)證配置

用途
查詢服務(wù)器上播出和推流認(rèn)證的配置情況。本接口會(huì)返回所有應(yīng)用的認(rèn)證配置信息，包括推流認(rèn)證和播放認(rèn)證的配置信息。
請(qǐng)求
authMgr/?request=list