接口规范 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认证的情况，该项仅对播出认证有效