接口規範 8. 播出認證相關接口

8 播出認證相關接口

8.1.開啓播出認證

• 用途
  針對某個應用，開啓播出認證。
  開啓播出認證後，所有播放該應用下的視頻流的請求都需要做合法性認證，只有認證通過的請求才會允許播放。
  認證的方法包括token認證、referer認證和第三方認證。
  token認證，就是爲每個播出流配置一個認證碼(token)，播放終端只有獲得該認證碼，並將該認證碼作爲播出請求的參數提交，才能夠正常播放視頻。
  referer認證，就是要求播放終端必須從某個域名下的網站發起播放請求，也就是隻有將播出視頻嵌入到某個指定域名下的網站才允許播放。
  第三方認證，就是將認證請求轉交給第三方系統的服務接口去認證，認證通過後才允許播放。開啓第三方認證後，所有本地認證策略會被忽略。

• 請求
  authMgr/?request=open_play_auth&application=liveshow
  application 應用名

• 響應

  {
  "code":0
  }

8.2.關閉播出認證

• 用途
  針對某個應用，關閉播出認證。關閉後播放該應用下的視頻流不需要做認證。

• 請求
  authMgr/?request=close_play_auth&application=liveshow
  application 應用名

• 響應

  {
  "code":0
  }

8.3.開啓和關閉播出token認證

• 用途
  針對某個應用，開啓和關閉播出token認證方式。
  設置該參數是爲了迎合僅使用referer認證情況。

• 請求
  authMgr/?request=open_play_token&application=liveshow&open=1
  application 應用名
  open 是否開啓認證，open=1表示開啓認證，open=0表示關閉認證

• 響應

  {
  "code":0
  }

8.4.查詢播出token

• 用途
  查詢某個應用下播出認證token的列表。
  每個token設置到一個視頻流上，播放客戶端訪問該視頻流需要給出正確的token值。

• 請求
  authMgr/?request=list_play_token&application=liveshow
  application 應用名

• 響應

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

  items元素包含當前應用下的token定義。
  application 應用名
  stream 流名稱
  token token值

8.5.添加播出token

• 用途
  爲視頻流添加播出認證token。
  每個token設置到一個視頻流上，播放客戶端訪問該視頻流需要給出正確的token值。

• 請求
  authMgr/?request=add_play_token&application=liveshow&stream=live1&token_val=8501E93883FC4D14
  application 應用名
  stream 流名稱
  token_val 添加的token值（注意這裏使用token_val參數名，避免與接口認證的token參數衝突）

• 響應

  {
  "code":0
  }

8.6.刪除播出token

• 用途
  刪除某個視頻流的token。

• 請求
  authMgr/?request=delete_play_token&application=liveshow&stream=live1
  application 應用名
  stream 流名稱

• 響應

  {
  "code":0
  }

8.7.設置播出認證的referer值

• 用途
  爲某個應用設置播出認證referer值。

• 請求
  authMgr/?request=set_referer&application=liveshow&url=play.ruiboyun.net;cloud.ruiboyun.net
  application 應用名
  url 允許訪問的域名列表，多個域名之間使用半角分號隔開。如果要撤銷referer認證，將url設爲空即可。

• 響應

  {
  "code":0
  }

8.8.設置第三方播出認證地址

• 用途
  將某個應用下的播出認證地址設置爲一個第三方認證地址。
  設置第三方認證地址後，所有本地認證策略失效。
  如果要取消第三方認證，將url參數設置爲空即可。

• 請求
  authMgr/?request=set_play_auth_url&application=liveshow&url=http://i.ruiboyun.net/interface
  application 應用名
  url 第三方認證接口的url地址，本參數需要進行【URL編碼】。

• 響應

  {
  "code":0
  }

8.9.查詢播出和推流認證配置

• 用途
  查詢服務器上播出和推流認證的配置情況。本接口會返回所有應用的認證配置信息，包括推流認證和播放認證的配置信息。

• 請求
  authMgr/?request=list

• 響應

  
  {
  "code":0,
  "data":{
      "count":1,
      "items":[
          {
              "application":"liveshow",
              "is_play_auth":0,
              "is_pub_auth":1,
              "play_auth_url":null,
              "pub_auth_url":"",
              "referer":null,
              "is_play_token_auth":0
          }
      ]
  }
  }

items應用下會返回多條記錄，每條記錄定義個應用的認證配置。
**application** 應用名
**is_play_auth** 是否開啓播放認證，0關閉，1開啓
**is_pub_auth** 是否開啓推流認證，0關閉，1開啓
**pub_auth_url** 推流第三方認證地址，null，"local"，""，或省略，都表示不使用第三方認證
**play_auth_url**  播出第三方認證地址，null，"local"，""，或省略，都表示不使用第三方認證
**referfer** 允許播出的域名列表，多個域名之間使用半角分號隔開，該項僅對播出認證有效
**is_play_token_auth** 是否開啓播出的token認證，0關閉，1開啓，使用該選項是爲了配合只使用referer認證的情況，該項僅對播出認證有效