API接口文档

 

状态码code对照表

code描述
-400没有ask或search请求,或者其值为空
-200有ask,值错误
-300有search,值错误
200banner请求成功
201~210banner请求成功,根据id返回201~210
301search请求成功,id有结果
302search请求成功,name有结果
303search请求成功,atrist有结果
304search请求成功,typee有结果
350musicList请求成功
360musicAll请求成功
500lrcs请求成功
-500lrcs请求失败,id错误
250todayMusic请求成功
260todayList请求成功

 

获取轮播图Banner

说明 : 调用此接口 , 可获取 banner( 轮播图 ) 数据

必选参数 : ask: 请求类型, 如 ask=banner

可选参数 : n或者id(两者二选一,如果同时设定n优先度高于id,可省略,默认显示5张图)。n表示要显示几张图的banner,n 取值 (2~10)之间,n不做设置或者设置错误则默认随机显示5张图。id表示要显示第几张图。当n和id同时被设置,并且都符合条件时,n的优先度大于id,即展示的是多图而非单图。只有n未设定或者n设定值不符合条件时,单独设定id展示对应banner。

接口地址 : /api.php

调用例1 : /api.php?ask=banner

返回JSON数据:

 

调用例2 : /api.php?ask=banner&n=2

返回JSON数据:

 

调用例3 : /api.php?ask=banner&id=8

返回JSON数据:

 

获取每日音乐推荐todayMusic

说明 : 调用此接口 , 可获取每日推荐播放列表todayList 数据

必选参数 : ask: 请求类型,如 ask=todayMusic

可选参数:n 请求数量,如 n=3,n的范围(2~5之间)没有定义或者不符合要求的n默认n=5.

接口地址 : /api.php

调用例子 : /api.php?ask=todayMusic&n=2

返回JSON数据:

 

 

获取播放列表musicList

说明 : 调用此接口 , 可获取 播放列表musicList 数据

必选参数 : ask: 请求类型, 如 ask=musicList

接口地址 : /api.php

调用例子 : /api.php?ask=musicList

返回JSON数据:

 

获取每日推荐列表todayList

说明 : 调用此接口 , 可获取每日推荐播放列表todayList 数据

必选参数 : ask: 请求类型,如 ask=todayList,根据请求会随机返回今日推荐列表数组

接口地址 : /api.php

调用例子 : /api.php?ask=todayList

返回JSON数据:

 

获取音乐库musicAll

说明 : 调用此接口 , 可获取 播放列表musicList 数据

必选参数 : ask: 请求类型, 如 ask=musicAll

接口地址 : /api.php

调用例子 : /api.php?ask=musicAll

返回JSON数据:

 

说明 : 调用此接口 , 歌曲数据

必选参数 : search: 要查找的内容,可以是:id、歌名、演唱者、歌曲类型,id需要精准匹配,其它可以模糊匹配。 如:search=5、 search=祖国、 search=宋、search=爱国

typee类型爱国歌曲、流行歌曲、经典老歌、儿歌、纯音乐、民歌

接口地址 : /api.php

调用例1 : /api.php?search=爱国

返回JSON数据:

 

调用例2 : /api.php?search=祖国

返回JSON数据:

调用例3 : /api.php?search=宋

返回JSON数据:

调用例4 : /api.php?search=5

返回JSON数据:

当数据不存在返回-300报错结果

 

调用例5 : /api.php?search=100

返回JSON数据:

 

获取歌词lrcs

说明 : 调用此接口 , 可获取 banner( 轮播图 ) 数据

必选参数 : ask: 请求类型, 如 ask=lrcs

必选参数 : id=n 显示id为n的歌曲歌词,如果n值错误则返回错误码

接口地址 : /api.php

 

调用例1 : /api.php?ask=lrcs&id=10

返回JSON数据:

 

调用例2 : /api.php?ask=lrcs&id=100

返回JSON数据: