开放平台api接口文档

开放平台api接口文档内容摘要：

203 授权码错误或者已过期 204 用户或授权服务器拒绝授予数据访问权限，比如当用户撤回了应用的OAuth2访问权限后再去调获取访问令牌接口会出现这个错误 205 grant_type值无效或者不支持，目前grant_type值只能为 authorization_code或 client_credentials 206 xpired access_token无效或者已过期 207 用户登陆失败， 用户名或密码错误 406 _word 搜索词中包含敏感词汇 500 调用开放平台内部服务发生错误 501 调用第三方服务发生错误 502 未知服务器错误 每个应用都有调用请求频率限制，如果超出限制就会返回 104 错误码。 目前限制规则如下：  测试环境：每个应用每分钟限额 200 次，每个应用每小时限额 3000 次  线上环境：待定 、 HTTP 响应码 HTTP 响应码说明如下： 响应码 描述 200 请求成功 201 创建成功 202 更新成功 301 请求永久重定向 302 请求临时重定向 304 未更改 400 请求地址不存在或者包含不支持的参数 401 未授权，因为未成功进行身份认证 403 被禁止访问，因为没有访问特定资源的权限 404 请求的资源不存在 422 服务器理解请求，但其中包含非法参数（如包含 XSS 攻击风险参数） 429 调用请求频率超出限额 500 服务器内部错误 OpenAPI 数据接口调用流程 、身份认证 在调用具体的 API数据接口前需要先通过 OAuth2接口获取 access_token访问令牌。 具体流程如下： a、客户端向喜马拉雅授权服务器进行身份认证，并要求一个访问令牌。 请求示例如下（注意 X指定是 HTTP POST请求， d指定请求参数）： curl X POST d client_id=[app_key]amp。 device_id=[设备唯一标识 ]amp。 grant_type=client_credentialsamp。 nonce=[随机字符串 ]amp。 timestamp=1453116822556amp。 sig=[签 名 ] 身份认证接口的所有参数已经如上列举了。 参数说明如下： client_id： 即 app_key，应用公钥 grant_type：固定值 client_credentials device_id： 设备唯一标识 ，比如对于 Android手机可以取 imei，其他物理设备可以取 MAC地址 nonce：随机字符 串 ， 长度建议 832位， 每次请求都要重新生成 timestamp： Unix毫秒数时间戳， 每次请求都要重新生成 sig：根据 参数 另外 注意：该请求的请求头 ContentType必须是 application/xformurlencoded b、喜马拉雅授权服务器确认请求参数无误后，向客户端返回 access_token访问令牌，以 JSON形式返回如下 （ 注意： access_token有过期时间，默认过期时间为 1天，过期后需要重新获取 ） ： { access_token: b994eebe844fcfcfaa62ecef523ee507, expires_in: 86400 // access_token过期时间，单位为秒 } 如果使用过期或者失效的 access_token请求 API，会返回如下响应： { error_no: 206, error_code: , error_desc: access_token is invalid or expired } 这种情况就需要重新请求获得 access_token。 、 OpenAPI 数据接口调用说明 、点播数据接口调用说明 点播接口调用步骤一般如下： 1. 先调用 /categories/list接口获取喜马拉雅点播数据分类； 2. 然后根据上一步得到的 category_id（分类 ID）调用 /tags/list接口获取某个分类下专辑标签或者声音标签： 3. 最后根据分类和标签就可以调用热门专辑接口或热门声音接口得到热门专辑列表 和热门声音列表 另外还可以通过下面两种方法获取专辑或声音数据： 1. 根据一批专辑 ID或者一批声音 ID，分别调用 /albums/get_batch、 /tracks_get_batch接口批量获取专辑或声音数据 2. 调用 /search/albums接口和 /search/tracks接口搜索某个分类下满足某个搜索词的专辑或声音数据 、直播数据接口调用说明 直播数据接口的调用步骤一般如下： 1. 如果要获取非省市直播电台数据，则直接调用 /live/radios接口；如果要获取省市直播电台数据，则先调用 /live/provinces接口获取省市列表数据，然后再调用/live/radios接口 2. 得到直播电台 ID后，既可以调用 /live/schedules接口获取直播电台节目排期数据，也可以调用 /live/get_playing_program接口获取该直播电台正在直播的节目 API 数据接口 、点播接口 、 /categories/list 功能 获取喜马拉雅内容分类 HTTP Method GET 参数 公共参数 返回值 返回分类列表，每个分类包含下列字段： 字段名 类型 描述 id Int 分类 ID kind String 固定值 category category_name String 分类名 cover_url_small String 分类封面小图 cover_url_middle String 分类封面中图 cover_url_large String 分类封面大图 order_num Int 排序值，值越小排序越在前 实例 URL d5de66fceb37da3amp。 client_os_type=2amp。 device_id=df529d6e9b56c15bamp。 pack_id=amp。 access_token=77eca96155c50179141549792edb7570amp。 sig=xxx 响应内容 [ { id: 1, kind: category, category_name: 最新资讯 , cover_url_small: xxx, cover_url_middle: xxx, cover_url_large: xxx, order_num: xxx }, ...... ] 注意事项  分类 ID 为 0 是热门分类，但该接口不返回 ID 为 0 的热门分类 、 /v2/tags/list 功能 获取专辑或声音的标签（ v2 版本标签）。 HTTP Method GET 参数 除公共参数外还包括下列参数： 字段名 类型 必填 描述 category_id Int 是 分类 ID，指定分类，为 0 时表示热门分类 type Int 是 指定查询的是专辑标签还是声音标签， 0专辑标签， 1声音标签 返回值 返回标签列表，每个标签包含下列字段： 字段名 类型 描述 tag_name String 标签名 kind String 固定值 tag 实例 URL de66fceb37da3amp。 client_os_type=2amp。 device_id=df529d6e9b56c15bamp。 pack_id=amp。 access_token=77eca96155c50179141549792edb7570amp。 category_id=3amp。 type=0amp。 sig=xx 响应内容 [ { tag_name: 脱口秀 , kind: tag, }, { tag_name: 排行榜 , kind: tag, }, ... ] 、 /v2/albums/list 功能 根据分类和标签获取某个分类某个标签下的热门专辑列表 /最新专辑列表 /最多播放专辑列表（ v2 版本） HTTP Method GET 参数 除公共参数外还包括下列参数： 字段名 类型 必填 描述 category_id Int 是 分类 ID，指定分类，为 0 时表示热门分类 tag_name String 否 分类下对应的专辑标签，不填则为热门分类 calc_dimension Int 是 计算维度，现支持最火（ 1），最新（ 2），经典或播放最多（ 3） page Int 否 返回第几页，必须大于等于 1，不填默认为 1 count Int 否 每页多少条，默认 20，最多不超过 200 返回值 字段名 类型 描述 total_page Int 总共多少页 total_count Int 专辑总数 current_page int 当前页码 category_id Int 分类 ID，为 1 时表示不属于任何分类 tag_name String 选填的标签名，无则返回空字符串 ”” albums Array 专辑列表，每个专辑包含下列字段：  id：专辑 ID  kind:固定值 album  album_title：专辑名称  album_tags：专辑标签列表  album_intro：专辑简介  cover_url_small：专辑封面小图  cover_url_middle：专辑封面中图  cover_url_large：专辑封面大图  announcer：专辑所属主播信息，包括 id（主播用户 ID）、 nickname（昵称）、 avatar_url（头像）和 is_verified（是否加 V）  play_count：专辑播放次数  favorite_count：专辑喜欢数  include_track_count：专辑包含声音数  last_uptrack：专辑中最新上传的一条声音信息，包括 track_id、 track_title、 duration、 created_at、updated_at 字段  remend_track：热门专辑推荐的声音 { uid: 主播 ID， human_remend_track_id：声音 ID human_remend_real_title：声音真实标题 human_remend_track_title：运营推荐标题 }  is_finished：是否完结， 0无此属性； 1未完结；2完结  can_download：能否下载， 布尔值 ， true可下载， false不可 下载  updated_at：专辑更新时间， Unix 毫秒数时间戳  created_at：专辑创建时间， Unix 毫秒数时间戳 实例 URL d5de66fceb37da3amp。 client_os_type=2amp。 device_id=df529d6e9b56c15bamp。 pack_id=amp。 access_token=77eca96155c50179141549792edb7570amp。 category_id=3amp。 tag_name=%E6%B5%AA%E6%BC%AB%E8%A8%80%E6%83%85amp。 page=1amp。 count=20amp。 sig=xxx 响应内容 { category_id: 3, total_page: 20, total_count: 393, current_page: 1, tag_name: 浪漫言情 , albums: [ { id: 2885924, kind: album, category_id: 3, album_title: 我不喜欢这世界，我只喜欢你 , album_tags: 我不喜欢这个世界 ,我只喜欢你 ,掷地有声 ,言情 , album_intro: 《我不喜欢这世界，我只喜欢你》 , cover_url_sm。