
版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
7、6.11.4、/openapi-collector-app/track_batch_records907、附录91注意:本文档所指的api接口必须在每次客户端请求数据的时候实时调用:可以由客户端直接调用,或者客户端贵方服务端喜马拉雅开放平台服务端。按商务协议,api调用方必须调用播放数据上传接口向喜马拉雅开放平台上传播放数据。1、背景本文档旨在为api对接提供统一的接口调用与交互规范。2、词汇说明app_key应用公钥,在创建开放平台应用时生成app_secret应用私钥,在创建开放平台应用时生成pack_id客户端包名,在创建开放平台应用时你填写的,对android客户端是包名,对ios客户
8、端是bundle id 3、请求数据包格式规范3.1、url所有api接口请求的url都是类rest风格,支持两种http 请求method:get和post。对于get请求,参数全部带在url的查询参数中,以key1=val1&key2=val2&.形式表示。对于post请求,参数则在post请求体中。3.2、参数3.2.1、公共参数所有api接口http请求都必须带上公共参数,否则会因参数验证失败而无法调用api接口。api对接时需要传下列公共参数:字段名类型必填描述app_keystring是开放平台应用公钥device_idstring是设备唯一标识,比如android系统可以传ime
10、需要。sigstring是参数签名,对除sig外所有参数进行签名计算得到的值。sig生成算法见3.2.2节3.2.2、签名生成算法api对接时签名参数sig生成步骤:a、将除了sig以外的所有请求参数的原始值按照参数名的字典序排序b、将排序后的华体会体育参数键值对用&拼接,即拼接成key1=val1&key2=val2&.c、将b步骤得到的字符串进行base64编码d、将app_secret作为哈希key对c步骤得到的base64编码后的字符串进行hmac-sha1哈希运算得到字节数组(注意这里是字节数组,千万不要转成十六进制字符串,否则签名计算会出错;一般的hmac-sha1算法得到的结果是字节数组的
11、十六进制表示,请务必留意这里是不同的。)e、对d步骤得到的字节数组进行md5运算得到32位字符串,即为sig3.2.3、q、tag_name特殊字符参数拼接说明q、tag_name参数的值可以包含一些特殊字符如%、+等,所以在拼接url时api调用方需要对q、tag_name的参数值做一次url编码,并且防止某些http客户端(比如ruby http客户端)对这些参数值做二次编码。举个例子:比如q的原始值为字符串幸福溜+7,如果不做任何处理拼接进url,比如/search/albums?q=幸福溜+7&.,那么服务端默认会做一次url解码,将参数q的
12、值解析为幸福 7,这是不正确的。所以api调用方在拼接url时需要对q、tag_name这种参数的值做一次url编码。4、响应数据包格式规范4.1、json格式输出响应数据以json格式输出,http响应头中的content-type为固定值application/json, charset=utf-8,字符编码格式为utf-8。4.2、错误响应输出格式错误响应输出包括error_no错误编号、error_code错误码和error_desc错误描述。其中error_no按照1xx系列到5xx系列对错误情况进行分组,比如1xx系列全部表示通用错误、2xx系列全部表示oauth 2相关错误、5x
17、r调用开放平台内部服务发生错误501ximalaya.system.thirdparty_service_error调用第三方服务发生错误502ximalaya.system.unknown_server_error未知服务器错误每个应用都有调用请求频率限制,如果超出限制就会返回104错误码。目前限制规则如下: 测试环境:每个应用每分钟限额200次,每个应用每小时限额3000次 线、http响应码http响应码说明如下:响应码描述200请求成功201创建成功202更新成功301请求永久重定向302请求临时重定向304未更改400请求地址不存在或者包含不支持的参数401未授权,
18、因为未成功进行身份认证403被禁止访问,因为没有访问特定资源的权限404请求的资源不存在422服务器理解请求,但其中包含非法参数(如包含xss攻击风险参数)429调用请求频率超出限额500服务器内部错误5、openapi数据接口调用流程5.1、身份认证在调用具体的api数据接口前需要先通过oauth2接口获取access_token访问令牌。具体流程如下:a、客户端向喜马拉雅授权服务器进行身份认证,并要求一个访问令牌。请求示例如下(注意-x指定是http post请求,-d指定请求参数):curl-x post-d client_id=app_key&device_id=设备唯一标识&gran
22、分类下专辑标签或者声音标签:3. 最后根据分类和标签就可以调用热门专辑接口或热门声音接口得到热门专辑列表和热门声音列表另外还可以通过下面两种方法获取专辑或声音数据:1. 根据一批专辑id或者一批声音id,分别调用/albums/get_batch、/tracks_get_batch接口批量获取专辑或声音数据2. 调用/search/albums接口和/search/tracks接口搜索某个分类下满足某个搜索词的专辑或声音数据5.2.2、直播数据接口调用说明直播数据接口的调用步骤一般如下:1. 如果要获取非省市直播电台数据,则直接调用/live/radios接口;如果要获取省市直播电台数据,则先
1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
DB31/T 1402-2023养老机构认知障碍照护单元设置和服务要求
2024秋新人教版小学一年级艺术唱游·音乐上册《第一单元 奇妙的声音世界》教案设计

