蜻蜓FM API
  1. 接入必读
蜻蜓FM API
  • 快速入门
    • 政策规范
      • 域名更新公告
      • 开发者协议
      • 品牌露出规范
    • 联系我们
      • 技术支持
  • API文档
    • 接入必读
      • 公共约定
      • 错误码说明
    • 账号授权API
      • 获取访问令牌_grant_type=client_credentials
      • 获取访问令牌_grant_type=authorization_code
      • 获取访问令牌_grant_type=refresh_token
      • 获取授权码
      • 注册新用户并取得访问令牌
    • 广播内容
      • 获取广播电台列表
      • 获取广播电台分类列表
      • 获取广播电台信息
      • 获取广播电台节目列表
    • 点播内容API
      • 实时点播内容更新通知
      • 获取点播专辑分类
      • 获取点播专辑列表
      • 获取点播专辑信息
      • 获取点播专辑节目列表
      • 批量获取点播专辑信息
      • 指定时间更新通知的集合
    • 内容运营API
      • 获取分类下的属性集合
        • 获取分类下的属性集合
        • 属性id用途
      • 搜索接口
      • 搜索接口
      • 搜索接口
      • 搜索热词
      • 获取排行榜
      • 运营推荐位
      • 相关推荐专辑
    • 数据回传API
      • 添加节目播放记录
      • 专辑曝光点击数据回传
    • 支付API
      • 打开收银台
      • 获取收银结算价
      • 创建订单
      • 确认订单
    • 分销API
      • 直充虚拟币
      • 直充接口
      • 查询合作方账户余额
    • 用户信息API
      • 获取用户信息
      • 获取用户收听历史
      • 获取用户收藏的专辑
    • 数据模型
      • token模型
      • 点播专辑模型
      • 点播节目模型
      • 广播电台模型
      • 广播节目模型
      • 订单模型
      • 用户信息模型
    • 付费查询API
      • 查询订单
      • 获取用户的订购列表
      • 查询付费专辑的播放权限
  • 资源下载
    • 移动SDK
      • 移动SDK下载
    • 小蜻蜓H5
      • 小蜻蜓H5接入
  • 添加节目播放记录
    POST
  • 添加节目播放记录
    POST
  • 添加节目播放记录
    POST
  • 添加节目播放记录
    POST
  • 添加节目播放记录
    POST
  • 添加节目播放记录
    POST
  • 添加节目播放记录
    POST
  • 添加节目播放记录
    POST
  • 添加节目播放记录
    POST
  • 添加节目播放记录
    POST
  • 添加节目播放记录
    POST
  1. 接入必读

公共约定

若无特殊说明,蜻蜓FM服务端接口使用如下公共约定。
api访问只支持https协议。测试接入域名为 open.staging.qingting.fm,正式域名上线前再分配。
若对信息安全有较高要求,可以在https通信基础上增加接入方客户端对蜻蜓的证书锁定(附 蜻蜓FM开放平台根证书地址https://dl.cacerts.digicert.com/DigiCertGlobalRootCA.crt)
请求和响应的body都使用json,编码方式为utf-8。
以下字段为所有API的公共参数,若无特殊说明所有请求都带有下列参数,通过header或query传入,如果同时提供query会覆盖header对应值。
header字段query字段值及说明
QT-Device-Iddevice_id当前接入方设备的设备号,务必保证设备号和设备一一对应,安卓设备建议填imei或md5(imei);若在接入方服务端调用需透传接入方客户端的设备号
QT-Access-Tokenaccess_token当前用户(匿名或具名)的授权凭据,授权之前请使用空字符串
QT-User-Iduser_id用户在蜻蜓侧的ID,由授权登录或静默登录获取。匿名用户请使用空字符串
QT-Coop-Open-Idcoop_open_id合作方用户ID,用来反查蜻蜓id(仅当使用client_credentials模式得到的token时生效)。如无需求,可以不用传
QT-Device-OSdevice_os设备操作系统(Android or ios)
QT-Device-OS-Versiondevice_os_version设备操作系统版本
QT-App-Versionapp_version设备应用版本
QT-Device-Modeldevice_model机型
响应都使用如下格式
{
    "data": {},
    "errcode": 123,
    "errmsg": "..."
}
分页读取列表的接口都有page和pagesize参数。page表示第几页,不填默认为1;pagesize表示每页大小。pagesize只能选择30或500,默认30。
分页读取列表的接口都会返回page,pagesize,total字段。
时间戳,超时时长,节目时长等时间单位都是秒。
部分api和所有的对外通知都要求对请求签名,以"QT-Sign"为键放入请求header中。生成签名的规则:sign_content(需要签名的内容,每个api可能不一样) 和 sign_key(默认client_secret) utf-8编码后拼在一起后,计算16进制md5摘要并大写。例如sign_key=123,sign_content为{"data":{"id":242222},"type":"channel_offline"},则签名为 md5hex('{"data":{"id":242222},"type":"channel_offline"}123').toUpperCase() = 391BD167845018EC270F7FDF29CAD218
上一页
技术支持
下一页
错误码说明
Built with