百家云双师课堂
产品文档 对接前温馨提示与声明 接口对接标准流程说明

接口对接标准流程说明

1、开通百家云平台账号

首先,欢迎所有用户体验百家云产品,需联系您的专属商务经理开通一个测试或者正式账号。

2、阅读开发者文档《对接前温馨提示与声明》

为了更好的理解开发过程,提高对接效率,恳请客户开发人员在开发前和开发过程中仔细阅读开发文档,并且参考Demo代码示例。

3、体验标准SAAS产品功能

我们建议开发者要先体验我们标准产品功能,在会使用的前提下开始做对接,这样便于您深入理解产品。

4、理解专属域名

专属域名即【个性域名】,参考:专属域名说明文档

百家云给每个用户账号都分配了一个专属域名,客户调用服务端API接口、对接用户端SDK的时候,都需要用到这个专属域名。

专属域名可以登录百家云后台,在【账号中心】页面查看。

当用户成为付费客户后,可以申请修改该专属域名(需要注意的是只能个性一次,修改后不可再更改)。

服务端的接口,都是调自己专属域名下的接口。

例如:专属域名前缀是demo123,则所有的服务端API请求的域名为:https://demo123.at.baijiayun.com/

为方便理解,服务端API接口中的专属域名前缀都用${private_domain}表示,在使用的时候请将该变量替换成自己的专属域名前缀。

5、掌握计算签名(sign)的规则

(1)前端进教室的签名方式参考: 直播进教室签名的计算文档

(2)服务端签名计算方式

直播服务端每个接口除了传递业务参数外,还有一个用于校验的sign参数。

sign的生成规则如下:

  • 将请求参数按key字典顺序(ASCII值大小)升序排序。
  • 将排好序的参数拼成 key1=value1&key2=value2&...&keyN=valueN
  • 将以上拼好的串后面再拼上 &partner_key=<partner_key> ,其中 <partner_key> 替换成具体值。
  • 对以上拼好的串算一个32位md5值(小写),即得到了签名。

注:

  • partner_key总是拼在字符串最后面,并不参与key的排序。
  • partner_key只是计算签名时需要,在发送请求时不需要发partner_key

6、明确需求及对接的终端

百家云为客户提供一站式视频技术服务,同时也提供丰富的API与SDK供客户对接,支持PC网页端(pc web)、手机网页端(手机h5)、Android、IOS、微信小程序等终端的对接需求。

7、双方约定与沟通方式

进入开始对接阶段,由百家云商务经理拉微信群对接、百家云支持人员提供对接支持。如客户有问题反馈,需要说明具体现象、提供产生的步骤等相关信息,百家云支持会及时响应处理。