新浪博客

弹弹play开放平台(v2版本)介绍

2018-04-23 18:43阅读:

开放平台介绍

请先阅读v1版本的介绍​ http://blog.sina.cn/dpool/blog/s/blog_58c506600102xds2.html?vt=4


在线文档和调试工具
https://api.acplay.net/swagger 点击进入后在上方下拉列表选择v2版本,然后点击右边的Explore按钮刷新API列表
弹弹play开放平台(v2版本)介绍
API分为无需验证和需要验证两种,无需验证的API包括获取弹幕、匹配文件等常见功能。需要验证的API会在接口说明文字里面提示。

需要验证API的调用流程

第一步,在你的应用(如网站或是后台脚本等)启动的时候,调用 POST https://api.acplay.net/api/v2/login 接口,提交json请求。
{
'userName': '你的弹弹play用户名',
'password': '密码',
'appId': '应用ID',
'unixTimestamp': 88888888,
'hash': '计算出的Hash'
}

Hash参数的计算方法
将登录请求中 appId password unixTimestamp userName 属性的值以及您应用的 AppSecret 密钥的值依次拼接起来, 计算出32MD5(不区分大小写)。举例来说,AppIDdandanplayAppSecretFFFFF,用户名为test1,密码为test2,那么计算方法将会是 hash=MD5(dandanplaytest2666666666test1FFFFF)

第二步,如果登录成功,返回的json中将包括一个“token”字段,这个token值就可以用于调用所有需要验证的API(比如首页、关注、搜索等)。这个token的有效期是21天(App开发者登录自己开发的App时有效期为一年),过期前可一直使用,建议把它的值缓存起来或者放到全局变量中,不用每次调用API前都刷新一遍。有效期中可以调用 /api/v2/login/renew 接口获取到包含新有效期的token。

第三步,调用API(以搜索API为例)
搜索API的地址是
GET https://api.acplay.net/api/v2/search/anime?keyword=关键词
在通过GET调用的时候,需要向HTTP Header中添加一个Authorization头,值为“Bearer+空格+刚才获取的token
Curl来表示的话,类似于
curl -X GET --header 'Accept:application/json' --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG……(完整的token)''https://api.acplay.net/api/v2/search/anime?keyword=eva'

返回的json类似于这样,具体每个字段的含义请参考在线文档
{
'animes': [
{
'animeId': 22,
'animeTitle': '新世纪福音战士',
'type': 'tvseries',
'typeDescription': 'TV动画',
'imageUrl': 'https://dandanimg.b0.upaiyun.com/anime/22.jpg',
'startDate': '1995-10-04T00:00:00',
'episodeCount': 26,
'isFavorited': false
},
{
'animeId': 202,
'animeTitle': '新世纪福音战士 The End of Evangelion',
'type': 'movie',
'typeDescription': '剧场版',
'imageUrl': 'https://dandanimg.b0.upaiyun.com/anime/202.jpg',
'startDate': '1997-07-19T00:00:00',
'episodeCount': 1,
'isFavorited': true
},
{
'animeId': 4847,
'animeTitle': '新世纪福音战士 新剧场版 ',
'type': 'movie',
'typeDescription': '剧场版',
'imageUrl': 'https://dandanimg.b0.upaiyun.com/anime/4847.jpg',
'startDate': '2007-09-01T00:00:00',
'episodeCount': 1,
'isFavorited': true
},
{
'animeId': 6184,
'animeTitle': 'EVA爆笑学园',
'type': 'web',
'typeDescription': '网络放送',
'imageUrl': 'https://dandanimg.b0.upaiyun.com/anime/6184.jpg',
'startDate': '2007-03-20T00:00:00',
'episodeCount': 24,
'isFavorited': false
}
],
'errorCode': 0,
'success': true,
'errorMessage': ''
}

在在线调试工具中调试需要验证的API

首先,你需要通过各种方式获取到token,可以通过代码调用的方式获取,或者是使用在线工具手动构建登录请求。
弹弹play开放平台(v2版本)介绍
获取到token之后,在页面右上角的文本框中,填写如下内容:
Bearer+空格+你的token
弹弹play开放平台(v2版本)介绍
然后点击Explore按钮,即可进入“已验证”的状态,之后在调用搜索API的时候,在线工具会自动在所有请求的http header中添加Authorization头。

我的更多文章

下载客户端阅读体验更佳

APP专享