小蜻蜓H5接入

名词约定

开放平台——蜻蜓FM开放平台，提供H5页面接入支持免费、付费内容输出

平台账号——合作方在开放平台上注册的账号，需要通过平台方审核

平台应用——合作方在开放平台上创建的应用

平台用户——使用合作方应用操作蜻蜓资源的用户，若无蜻蜓账号则为匿名用户

client_id——应用编号

client_secret——应用秘钥

前端——合作方应用的前端（使用服务端API和H5页面）

服务端——合作方应用的服务端（使用服务端API和开放平台通信）

场景介绍

适用于合作方以H5方式集成我方内容，完成内容消费以及付费转化。

合作方集成蜻蜓开放平台提供的H5页面，支持在固定入口调起由我方运营的前端页面，用户可进行收听、购买等一系列操作。

接入准备

开放平台注册与创建应用详情见：接入流程

正式接入

1、前端操作

1.1、注意事项：

接入地址query必须带入client_id。

client_id与client_secret在开放平台注册并创建应用后，在我的应用中查看。

域名+path可以根据自己需求进行自由拼接，可以直接进入具体的页面。(如果默认为主页则不需要拼接任何path)。

如果需要直接进入指定的专辑页，category_id、channel_id、porgram_id等需要通过服务端调用API接口，获取到相应的ID。

1.2、小蜻蜓前端域名：

测试环境：mini.staging.qingting.fm

生产环境：mini.qingting.fm

1.3、跳转页面:

path列表：

path	介绍
/	主页
/categories/category_id	分类页
/channels/channel_id	专辑页（简介tab）
/channels/channel_id/programs	专辑页（节目列表tab）
/programs/program_id	播放页
/my	我的页
/my/favs	我的收藏页
/my/bought-items	我的已购页

1.4、入口配置：

地址格式：

域名/path?client_id=client_id

将接入地址配置在需要接入的入口处，如：https://mini.staging.qingting.fm/?client_id=client_id

注意：该配置地址默认进入页面为主页，如需配置其他页面作为进入页面，需要输入服务端调用API接口后获取的ID，再拼接上相应的页面PATH即可。

2、服务端操作

提示：前端配置完成后已完成小蜻蜓的接入。如需更改默认进入页面，获取音频数据等操作，则需要服务端以下操作

2.1、API接口：

API使用说明详见：API接口文档

常用媒资获取接口如下：

接口描述	接口名	其他说明
获取访问令牌	/auth/v7/access	有多种方式获取访问令牌
获取点播专辑分类列表	/media/v7/categories	一级分类，如：相声小品、脱口秀、历史等
获取点播专辑分类中的专辑列表	/media/v7/channelondemands?category_id= category_id	通过分类ID获取某个分类专辑列表
获取单个点播专辑	/media/v7/channelondemands/channel_id	根据分类下的专辑ID获取到相应的专辑，包含相应专辑的详细信息
获取点播专辑节目列表	/media/v7/channelondemands/channel_id/programs?program_id=program_id	获取到相应专辑的播放列表，类似于某部电视剧的集列表
批量获取点播专辑	/media/v7/batch_channelondemands?channel_ids=channel_ids	获取指定的点播专辑，可单个或者多个同时获取。channel_ids=后可以单个或多个点播专辑ID，ID之间用逗号隔开

注意事项：

调用API接口需要登录开放平台https://open.qingting.fm,在我的应用中查询`client_id`、`client_secret` 。

获取token后方可调用接口

测试环境与生产环境的域名不同，在各自环境中获取的token只能在各自的环境中使用，否则会报错。

媒资接口有层级关系，可以通过层级的接口可以获取到具体的媒资数据。

服务端操作获取category_id示例：

获取token

接口：/auth/v7/access

示例代码:

2.返回token：

   {  "data": {      "access_token": "NTg2ZjNjMTItMTA0My00MDAyLThlY2EtMDBlODMzZWZkMmRj",      "expires_in": 23304,      "refresh_token": "",      "user_id": ""   },   "errcode": 0,   "errmsg": "Success" }

3.调用接口

获取token后，调用上表中获取媒资的各个接口。示例代码：

4.返回结果：

  {
              "errcode": 0,
              "errmsg": "Success",
              "data": [
                  {
                      "id": 521,
                      "name": "小说"
                  }
              ]
          }

结果说明：

参数	类型	说明
id	int	点播专辑分类ID，即category_id
name	string	点播专辑分类名称

API接口错误码

错误码详情见：错误码说明

名词约定#

场景介绍#

接入准备#

正式接入#

名词约定

场景介绍

接入准备

正式接入