Giter Site home page Giter Site logo

keyzf / rolltoolsapi Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mzcretin/rolltoolsapi

0.0 1.0 0.0 1.49 MB

一个提供开发中常用数据的一个稳定聚合Api接口源,运行于独立服务器,免费,且长期维护,会持续添加新的接口!

Home Page: https://www.mxnzp.com

License: MIT License

rolltoolsapi's Introduction

RollToolsApi

大道至简系列

需求解决系列之-【系列工具概览】 此系列是大道至简的起始,将一系列简单恶心的操作封装起来,框架么,可以败絮其中,但一定要金絮其外!

一个提供开发中常用数据的一个稳定聚合Api接口源,运行于独立服务器,截止目前此服务已持续运行超过一年,服务器配置升级14次以上。免费,且长期维护,会持续添加新的接口!

如果在使用过程中有什么问题,或者有什么好的意见或者建议,都可以与我联系,[email protected],或者扫描下方微信二维码添加我为好友,联系我请注明您的来意!

主页地址:ROLL,目前接口已经支持https请求,推荐使用 https://www.mxnzp.com ,更安全,http://www.mxnzp.com 可继续使用,域名已经成功备案

解锁新方式

郑重说明:非app_id请求方式将于2020年4月1日停止对外服务,请替换成app_id请求的方式,否则将无法正常使用接口!届时将拦截所有非app_id的请求,对您的使用造成影响,敬请谅解!

想体验接口? 可获取临时app_id测试,获取方式:扫描下方小程序码->选择TAB-我的->点击获取临时app_id即可获取临时体验接口的app_id和app_secret,此app_id仅为测试使用,次日凌晨自动重置,重置之后之前生成的app_id将失效,真正使用接口请申请属于自己专属的app_id。

  • 各位开发者,为了更方便的使用,经过一段时间的努力,开通了app_id和app_secret方式请求接口的方式,使用此方式最大的好处在于不会再有使用上的限制,包括你可以在你的服务器中调用,包括不会限制你的调用频率,包括不会封IP!
  • 如何注册app_id和app_secret呢?扫描下方小程序码(或者搜索小程序【Roll地盘】),进入我的页面,绑定手机号之后即可获取你的专属app_id和app_secret,使用新方式吧*年!
  • 如何确定是否正确使用了app_id的方式呢?
    • 扫描下方小程序码(或者搜索小程序【Roll地盘】),进入我的页面,点击数据统计,这里将会显示接口的调用情况,如果配置正确,这里将会有统计数据。
  • 如何使用呢?
    • 在每个请求链接后面添加app_id=你的app_id&app_secret=你的app_secret两个参数,如果是POST请求,需要将两个参数放在参数列表中请求
    • 【推荐方案】在请求头header中添加app_id=你的app_id&app_secret=你的app_secre两个参数,更加方便

特别声明

最近问的一个比较多的问题就是,接口访问404,在这里我想说,请各位大佬仔细阅读文档,仔细阅读文档,仔细阅读文档,尤其是"通用"模块的文档,我们的Host地址是域名+/api(https://www.mxnzp.com/api),不是纯域名,不要再来问题这个问题了。。。一个正常的请求应该是 https://www.mxnzp.com/api/xxxxx

随着使用本api用户的增多,每一次对服务器的升级维护,都需要格外小心,否则将会影响到用户的使用。特此创建了一个交流群,旨在交流使用通用接口中遇到的问题,以及其他新接口的建议,群中大佬云集,可以进行学术交流!有新接口的诞生也方便通知大家!另外一个作用就是,如果接口需要停机维护,会提前在群中通知,以免对大家的使用带来不便以及损失!

前期开放扫描二维码进群的方式让群里多了很多发布淫秽,色情,赌博的广告信息,现关闭此方式,需要加群的请添加我微信好友,我拉你入群(备注下通用API),感谢您的支持!

自助IP解封:对于使用中逻辑不正确导致的IP封禁,现提供自助解封方式,微信公众号搜索《Cretin的开发之路》,回复任意消息可召唤出自助服务系统,按照说明进行IP自助解封!如图三


目录


通用

  • HOST地址: 推荐使用https接口更安全:https://www.mxnzp.com/api 之前的 http://www.mxnzp.com/api 可继续使用不受影响!

  • app_id和app_secret方式请求(摆脱被封IP的限制,可在服务器中调用接口):

    • 在参数中添加app_id=你的app_id&app_secret=你的app_secret
    • 【推荐方案】在请求头header中添加app_id=你的app_id&app_secret=你的app_secret
    • 唯一获取app_id和app_secret方式,扫描上方小程序码进行操作!
  • 说明: 所有的接口都会返回如下格式的数据,具体数据包装在data中,需要根据状态来确定请求是否成功。

  • 请求方法: 所有的请求中都是大部分都是GET请求(如果有特殊情况,则会特殊标明)

  • 数据返回格式:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": null
    }
  • 数据返回格式说明(下面所有接口中的数据返回都是基于data的,不再介绍code和msg,请知悉):

    • code: 状态码 1 返回成功 0 返回失败 此时,请关注msg错误信息
    • msg: 提示信息,当code返回0的时候包含错误提示信息
    • data: 主要信息,不同接口返回的东西不一样
  • 列表数据格式说明(大部分列表数据都满足下列格式,特殊接口除外,在此特别说明,后面就不再赘述了)

    • page: 当前页数
    • totalCount: 总数量
    • totalPage: 总页数
    • limit: 每页数量
    • list: 每页具体数据
      • 具体列表数据模型

更新记录

2020-06-08 16:36:29

  • 节假日及万年历相关接口新增 indexWorkDayOfMonth 字段,此字段返回是当前月的第几个工作日,二、节假日及万年历
  • 天气接口新增天气描述,风力描述,风向描述清单,附件

2020-02-26 21:47:39

2020-01-17 14:53:43

2020-01-16 22:16:09

2020-01-13 23:28:37

2019-11-20 10:12:34

  • 新增app_id+app_secret 方式请求接口,使用此方式可避免请求限流以及封禁IP。解锁新方式
  • 新开发《Roll地盘》小程序,可以申请app_id+app_secret,可以查询你申请的app_id下每日请求统计数据!

2019-09-09 09:44:35

2019-08-28 12:10:13

2019-08-10 19:23:14

2019-08-06 23:09:05

  • 新增其他彩种的彩票信息,包括之前的双色球一共七种彩种,聚合成一个接口方便调用,当然,之前的双色球接口使用已做兼容处理,不会受到影响!查看说明

2019-07-24 23:54:27

  • 新增物流查询的接口,查看说明
  • 段子接口当请求页数超过最大页数时返回空数组
  • 修复一些已知的bug

2019-07-10 20:22:17

2019-07-08 17:59:41

  • 新增垃圾分类信息查询接口,查看说明
  • 修复线上一些已知bug

2019-07-05 19:15:06

  • 新增获取不同类型最新新闻的接口,查看说明

2019年07月02日 19:30:22

2019年06月05日15:54:50

  • 新增查询手机归属地的接口,查看说明
  • IP地址查询的接口逻辑优化,数据搜索更加准确,查看说明
  • 音乐搜索新增page参数,可实现数据分页查询,查看说明

2019年05月22日13:07:41

  • 新增音乐相关接口,拥有这些接口,基本上可以实现一个小的音乐播放器,查看说明

2019年05月15日11:57:20

  • 新增国家电话区号列表接口,查看说明
  • 国家城市列表接口新增世界级国家城市列表查询,查看说明

2019年04月11日23:59:55

  • 服务器已经支持https请求,之前的http请求不受影响!

2019年03月13日11:27:58

  • 一、服务器硬件更新
    • 1、升级服务器内存和cpu
  • 二、接口更新(本次没有新接口添加)
    • 1、节假日api的假日信息更新到2002年,2002年之前的节假日信息国务院没有发布,不再做统计!查看说明
    • 2、节假日api每日信息新增星座字段!查看说明
    • 3、修复天气api模糊搜索的bug,现在搜索会先全量匹配,匹配不到才会进行模糊匹配!查看说明

2019年01月29日09:53:10

  • 新增生成条形码接口,可以生成商品对应的条形码,查看说明;新增条形码对应的商品信息,输入条形码上的商品code,可以获取对应的商品信息,查看说明

2019年01月09日20:16:38

  • 新增生成随机验证码的接口,可以生成任意长度的验证码图片,查看说明;段子接口新增随机段子列表,可以获取随机段子,查看说明

2018年12月14日15:02:00

  • 新增生成二维码的接口,可生成指定大小,指定内容的二位么,也可生成带logo的二维码。查看说明

2018年12月10日22:54:46

  • 节假日及万年历接口添加新的接口,添加查询指定类型的节假日信息列表,比如节日,休息日,工作日 查看说明查看说明

2018年12月07日09:20:07

  • 添加正式域名,可用正式域名访问 查看说明

2018年12月01日22:49:42

2018年11月27日23:14:49


捐赠

由于服务器端的维护以及部分接口的维护都是需要付费的,所以如果此项目对您有帮助,还希望您捐赠支持,让我能好好的一直坚持下去。金额不在于多少,一份心意就好!在此感谢捐赠列表中所有的捐赠者,你们的鼓励是我最大的动力!捐赠列表

    
---------

版权声明

本站所对外提供的Api接口中,部分数据来源于网络,如有侵权,请联系我进行处理!

本站所提供的所有Api接口仅仅是秉承交流学习的**,没有任何盈利的行为,用户在使用过程中造成的版权问题由使用者自行承担,与本站维护者无关,请知悉!


接口列表

一、通用彩票信息接口

指定期号通用中奖号码

  • 接口说明: 获取指定期号的通用获奖号码信息

  • 接口地址: [HOST]/lottery/common/aim_lottery?expect=18135&code=ssq

  • 参数说明: expect:彩票期号必传,code:(彩票种类标识,目前提供七种彩种)

    • ssq:双色球
    • qlc:七乐彩
    • fc3d:福彩3D
    • cjdlt:超级大乐透
    • qxc:七星彩
    • pl3:排列3
    • pl5:排列(5)
  • 返回数据:

    • openCode: 本期中奖号码
    • code: 彩票编号标识
    • expect: 彩票期号
    • name: 彩票名称
    • time: 发布时间
  • 数据样例:

    {
        "openCode": "01,03,06,10,11,29+16",
        "code": "ssq",
        "expect": "18135",
        "name": "双色球",
        "time": "2018-11-18 21:18:20"
    }

最新通用中奖号码信息

  • 接口说明: 获取最新通用中奖号码信息

  • 接口地址: [HOST]/lottery/common/latest?code=ssq

  • 参数说明: code:(彩票种类标识,目前提供七种彩种)

    • ssq:双色球
    • qlc:七乐彩
    • fc3d:福彩3D
    • cjdlt:超级大乐透
    • qxc:七星彩
    • pl3:排列3
    • pl5:排列5
  • 返回数据:

    • openCode: 本期中奖号码
    • code: 彩票编号标识(双色球是ssq)
    • expect: 彩票期号
    • name: 彩票名称
    • time: 发布时间
  • 数据样例:

    {
        "openCode": "10,12,15,25,26,27+14",
        "code": "ssq",
        "expect": "18136",
        "name": "双色球",
        "time": "2018-11-20 21:18:20"
    }

最近历史开奖数据

  • 接口说明: 获取最近历史开奖数据

  • 接口地址: [HOST]/lottery/common/history【例如: [HOST]/lottery/common/history?code=ssq&size=10】

  • 参数说明: size:获取历史数据的条数,最多50条,code:(彩票种类标识,目前提供七种彩种)

    • ssq:双色球
    • qlc:七乐彩
    • fc3d:福彩3D
    • cjdlt:超级大乐透
    • qxc:七星彩
    • pl3:排列3
    • pl5:排列5
  • 返回数据:

    • openCode: 本期中奖号码
    • code: 彩票编号标识
    • expect: 彩票期号
    • name: 彩票名称
    • time: 发布时间
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "openCode": "01,04,12,13,30,32+08",
                "code": "ssq",
                "expect": "19100",
                "name": "双色球",
                "time": "2019-08-27 21:18:20"
            },
            ...这里只展示了条...
        ]
    }

获取彩种信息

  • 接口说明: 获取系统支持的彩种类型详细信息

  • 接口地址: [HOST]/lottery/common/types【例如: [HOST]/lottery/common/types】

  • 参数说明:

  • 返回数据:

    • typeName: 彩种名称
    • typeCode: 彩票种类标识
    • openTime: 彩种对应的开奖时间
    • startTime: 彩种对应的发行时间
    • ruleDesc: 彩种相关描述和规则
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "typeName": "双色球",
                "typeCode": "ssq",
                "openTime": "每周二、四、日开奖",
                "startTime": "2003年2月16日",
                "ruleDesc": "一等奖(6+1):浮动。\n二等奖(6+0):浮动。\n三等奖(5+1):单注奖金固定为3000元。\n四等奖(5+0、4+1):单注奖金固定为200元。\n五等奖(4+0、3+1):单注奖金固定为10元。\n六等奖(2+1、1+1、0+1):单注奖金固定为5元。"
            },
            ...这里只显示了条...
        ]
    }

中奖结果计算

  • 接口说明: 获取彩票的中奖结果,根据投注的彩票号码及期数判断是否中奖,暂只支持双色球、大乐透、七乐彩和七星彩;结果根据一定算法进行计算,如有偏差,请以官方为准!

  • 接口地址: [HOST]/lottery/common/check【例如: [HOST]/lottery/common/check?code=cjdlt&expect=19090&lotteryNo=13,19,28,30,33@02,12】

  • 参数说明: expect:彩票期号,lotteryNo:购买的号码,号码之间用英文逗号隔开,红色球和蓝色求之间用@连接,例如:13,19,28,30,33@02,12,code:(彩票种类标识,目前提供七种彩种)

    • ssq:双色球
    • qlc:七乐彩
    • fc3d:福彩3D
    • cjdlt:超级大乐透
    • qxc:七星彩
    • pl3:排列3
    • pl5:排列5
  • 返回数据:

    • resultList: 本期中奖号码分析结果
      • num: 用户实际号码的单个号码
      • lottery: 此单个号码是否中奖
      • blue: 此单个号码是否是蓝号
    • resultDetails: 计算中奖结果描述
    • resultDesc: 计算结果
    • openCode: 期号对应的实际中奖号码
    • checkedCode: 用户上传的被检测的实际号码
    • expect: 期号
    • code: 彩种类型标识
    • codeValue: 彩种类型描述
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "resultList": [
                {
                    "num": "13",
                    "lottery": true,
                    "blue": false
                },
                ...这里只展示条...
            ],
            "resultDetails": "一等奖,奖金跟随奖池浮动",
            "resultDesc": "5+2",
            "openCode": "13,19,28,30,33+02+12",
            "checkedCode": "13,19,28,30,33@02,12",
            "expect": "19090",
            "code": "cjdlt",
            "codeValue": "超级大乐透"
        }
    }

二、节假日及万年历

指定日期的节假日及万年历信息


2018-11-26 18:07:28更新: 节假日新增类型描述,比如【国庆,休息日,工作日】


  • 接口说明: 获取指定日期的节假日及万年历信息

  • 接口地址: [HOST]/holiday/single/{date} 【例如: [HOST]/holiday/single/20181121】

  • 参数说明: date 日期 格式 yyyyMMdd

  • 返回数据:

    • date: 当前日期
    • weekDay: 当前周第几天 1-周一 2-周二 ... 7-周日
    • yearTips: 天干地支纪年法描述 例如:戊戌
    • type: 类型 0 工作日 1 假日 2 节假日
    • typeDes: 类型描述 比如 国庆,休息日,工作日
    • chineseZodiac: 属相 例如:狗
    • solarTerms: 节气描述 例如:小雪
    • lunarCalendar: 农历日期
    • suit: 宜事项
    • dayOfYear: 这一年的第几天
    • weekOfYear: 这一年的第几周
    • constellation: 星座
    • indexWorkDayOfMonth: 如果当前是工作日 则返回是当前月的第几个工作日,否则返回0
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "date": "2018-11-21",
            "weekDay": 3,
            "yearTips": "戊戌",
            "type": 0,
            "typeDes": "工作日",
            "chineseZodiac": "狗",
            "solarTerms": "立冬后",
            "avoid": "嫁娶.安葬",
            "lunarCalendar": "十月十四",
            "suit": "破屋.坏垣.祭祀.余事勿取",
            "dayOfYear": 325,
            "weekOfYear": 47,
            "constellation": "天蝎座",
            "indexWorkDayOfMonth": 1
        }
    }

指定多个日期的节假日及万年历信息

  • 接口说明: 获取指定多个日期的节假日及万年历信息

  • 接口地址: [HOST]/holiday/multi/{dates} 【例如: [HOST]/holiday/multi/20180101,20181010,20181011】

  • 参数说明: dates 日期组 格式 yyyyMMdd,yyyyMMdd,yyyyMMdd (中间用英文逗号隔开)

  • 返回数据:

    • date: 当前日期
    • weekDay: 当前周第几天 1-周一 2-周二 ... 7-周日
    • yearTips: 天干地支纪年法描述 例如:戊戌
    • type: 类型 0 工作日 1 假日 2 节假日
    • typeDes: 类型描述 比如 国庆,休息日,工作日
    • chineseZodiac: 属相 例如:狗
    • solarTerms: 节气描述 例如:小雪
    • lunarCalendar: 农历日期
    • suit: 宜事项
    • dayOfYear: 这一年的第几天
    • weekOfYear: 这一年的第几周
    • constellation: 星座
    • indexWorkDayOfMonth: 如果当前是工作日 则返回是当前月的第几个工作日,否则返回0
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "date": "2018-01-01",
                "weekDay": 1,
                "yearTips": "丁酉",
                "type": 2,
                "chineseZodiac": "鸡",
                "solarTerms": "冬至后",
                "avoid": "出行.安葬.修坟.开市",
                "lunarCalendar": "11-15",
                "typeDes" : "元旦",
                "suit": "祭祀.塑绘.开光.裁衣.冠笄.嫁娶.纳采.拆卸.修造.动土.竖柱.上梁.安床.移徙.入宅.安香.结网.捕捉.畋猎.伐木.进人口.放水",
                "dayOfYear": 1,
                "weekOfYear": 1,
                "constellation": "天蝎座",
                "indexWorkDayOfMonth": 1
            },
            {
                "date": "2018-10-10",
                "weekDay": 3,
                "yearTips": "戊戌",
                "type": 0,
                "chineseZodiac": "狗",
                "solarTerms": "寒露后",
                "typeDes" : "工作日",
                "avoid": "造庙.嫁娶.掘井.栽种.造桥.作灶.动土",
                "lunarCalendar": "9-2",
                "suit": "祭祀.开光.出行.解除.伐木.作梁.出火.拆卸.入宅.移徙.安床.修造.造畜椆栖.扫舍",
                "dayOfYear": 283,
                "weekOfYear": 41,
                "constellation": "天蝎座",
                "indexWorkDayOfMonth": 1
            },
            {
                "date": "2018-10-11",
                "weekDay": 4,
                "yearTips": "戊戌",
                "type": 0,
                "typeDes" : "工作日",
                "chineseZodiac": "狗",
                "solarTerms": "寒露后",
                "avoid": "入宅.上梁.斋醮.出火.谢土",
                "lunarCalendar": "9-3",
                "suit": "纳采.订盟.开市.交易.立券.会亲友.纳畜.牧养.问名.移徙.解除.作厕.入学.起基.安床.开仓.出货财.安葬.启攒.入殓.除服.成服",
                "dayOfYear": 284,
                "weekOfYear": 41,
                "constellation": "天蝎座",
                "indexWorkDayOfMonth": 1
            }
        ]
    }

指定月份所有的节假日及万年历信息

  • 接口说明: 获取指定月份的节假日及万年历信息

  • 接口地址: [HOST]/holiday/list/month/{date} 【例如: [HOST]/holiday/list/month/201802】

  • 参数说明: date 查询的月份 格式 yyyyMM (只有年月)

  • 返回数据:

    • date: 当前日期
    • weekDay: 当前周第几天 1-周一 2-周二 ... 7-周日
    • yearTips: 天干地支纪年法描述 例如:戊戌
    • type: 类型 0 工作日 1 假日 2 节假日
    • typeDes: 类型描述 比如 国庆,休息日,工作日
    • chineseZodiac: 属相 例如:狗
    • solarTerms: 节气描述 例如:小雪
    • lunarCalendar: 农历日期
    • suit: 宜事项
    • dayOfYear: 这一年的第几天
    • weekOfYear: 这一年的第几周
    • constellation: 星座
    • indexWorkDayOfMonth: 如果当前是工作日 则返回是当前月的第几个工作日,否则返回0
  • 数据样例:

    {
    
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "date": "2018-02-01",
                "weekDay": 4,
                "yearTips": "丁酉",
                "type": 0,
                "chineseZodiac": "鸡",
                "typeDes" : "工作日",
                "solarTerms": "大寒后",
                "avoid": "开仓.嫁娶.移徙.入宅",
                "lunarCalendar": "12-16",
                "suit": "祭祀.沐浴.祈福.斋醮.订盟.纳采.裁衣.拆卸.起基.竖柱.上梁.安床.入殓.除服.成服.移柩.启攒.挂匾.求嗣.出行.合帐.造畜椆栖",
                "dayOfYear": 32,
                "weekOfYear": 5,
                "constellation": "天蝎座",
                "indexWorkDayOfMonth": 1
            },
            ...中间隐藏了"2018-02-02"~"2018-02-27"的数据
            {
                "date": "2018-02-28",
                "weekDay": 3,
                "yearTips": "戊戌",
                "type": 0,
                "chineseZodiac": "狗",
                "typeDes" : "工作日",
                "solarTerms": "雨水后",
                "avoid": "掘井",
                "lunarCalendar": "1-13",
                "suit": "祭祀.斋醮.裁衣.合帐.冠笄.订盟.纳采.嫁娶.入宅.安香.谢土.入殓.移柩.破土.立碑.安香.会亲友.出行.祈福.求嗣.立碑.上梁.放水",
                "dayOfYear": 59,
                "weekOfYear": 9,
                "constellation": "天蝎座",
                "indexWorkDayOfMonth": 1
            }
        ]
    
    }

指定月份指定类型的所有的节假日及万年历信息

  • 接口说明: 获取指定月份的节假日及万年历信息

  • 接口地址: [HOST]/holiday/list/month/{date}/{type} 【例如: [HOST]/holiday/list/month/201810/rest】

  • 参数说明: date 查询的月份 格式 yyyyMM (只有年月),type 需要查询的类型{可选值:类型 workday 工作日 holiday 节假日 rest 休息日 festival 节日}

  • 返回数据:

    • month: 当前月份
    • year: 当前年份
      • date: 当前日期
      • weekDay: 当前周第几天 1-周一 2-周二 ... 7-周日
      • yearTips: 天干地支纪年法描述 例如:戊戌
      • type: 类型 0 工作日 1 假日 2 节假日
      • typeDes: 类型描述 比如 国庆,休息日,工作日
      • chineseZodiac: 属相 例如:狗
      • solarTerms: 节气描述 例如:小雪
      • lunarCalendar: 农历日期
      • suit: 宜事项
      • dayOfYear: 这一年的第几天
      • weekOfYear: 这一年的第几周
      • constellation: 星座
      • indexWorkDayOfMonth: 如果当前是工作日 则返回是当前月的第几个工作日,否则返回0
  • 数据样例

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "month": 10,
                "year": 2018,
                "days": [
                    {
                        "date": "2018-10-13",
                        "weekDay": 6,
                        "yearTips": "戊戌",
                        "type": 1,
                        "typeDes": "休息日",
                        "chineseZodiac": "狗",
                        "solarTerms": "寒露后",
                        "avoid": "开市.交易.祭祀.入宅.安葬",
                        "lunarCalendar": "九月初五",
                        "suit": "捕捉.畋猎.余事勿取",
                        "dayOfYear": 286,
                        "weekOfYear": 41,
                        "constellation": "天蝎座",
                        "indexWorkDayOfMonth": 1
                    },
                    ...中间隐藏了部分的数据...
                    {
                        "date": "2018-10-28",
                        "weekDay": 7,
                        "yearTips": "戊戌",
                        "type": 1,
                        "typeDes": "休息日",
                        "chineseZodiac": "狗",
                        "solarTerms": "霜降后",
                        "avoid": "出行.祈福.安葬.作灶",
                        "lunarCalendar": "九月廿",
                        "suit": "会亲友.嫁娶.订盟.纳采.纳婿.拆卸.修造.动土.起基.竖柱.上梁.安床.会亲友.纳财",
                        "dayOfYear": 301,
                        "weekOfYear": 43,
                        "constellation": "天蝎座",
                        "indexWorkDayOfMonth": 1
                    }
                ]
            }
        ]
    }

指定年份所有的节假日及万年历信息

  • 接口说明: 获取指定年份的节假日及万年历信息

  • 接口地址: [HOST]/holiday//list/year/{date} 【例如: [HOST]/holiday/list/year/2018】

  • 参数说明: date 查询的年份 格式 yyyy (只有年份)

  • 返回数据:

    • month: 当前月份
    • year: 当前年份
      • date: 当前日期
      • weekDay: 当前周第几天 1-周一 2-周二 ... 7-周日
      • yearTips: 天干地支纪年法描述 例如:戊戌
      • type: 类型 0 工作日 1 假日 2 节假日
      • typeDes: 类型描述 比如 国庆,休息日,工作日
      • chineseZodiac: 属相 例如:狗
      • solarTerms: 节气描述 例如:小雪
      • lunarCalendar: 农历日期
      • suit: 宜事项
      • dayOfYear: 这一年的第几天
      • weekOfYear: 这一年的第几周
      • constellation: 星座
      • indexWorkDayOfMonth: 如果当前是工作日 则返回是当前月的第几个工作日,否则返回0
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "month": 1,
                "year": 2018,
                "days": [
                    {
                        "date": "2018-01-01",
                        "weekDay": 1,
                        "yearTips": "丁酉",
                        "type": 2,
                        "chineseZodiac": "鸡",
                        "solarTerms": "冬至后",
                        "typeDes" : "元旦",
                        "avoid": "出行.安葬.修坟.开市",
                        "lunarCalendar": "11-15",
                        "suit": "祭祀.塑绘.开光.裁衣.冠笄.嫁娶.纳采.拆卸.修造.动土.竖柱.上梁.安床.移徙.入宅.安香.结网.捕捉.畋猎.伐木.进人口.放水",
                        "dayOfYear": 1,
                        "weekOfYear": 1,
                        "constellation": "天蝎座",
                        "indexWorkDayOfMonth": 1
                    },
                    ...中间隐藏了"2018-01-02"~"2018-01-30"的数据
                    {
                        "date": "2018-01-31",
                        "weekDay": 3,
                        "yearTips": "丁酉",
                        "type": 0,
                        "chineseZodiac": "鸡",
                        "typeDes" : "工作日",
                        "solarTerms": "大寒后",
                        "avoid": "嫁娶.入殓.安葬.出行",
                        "lunarCalendar": "12-15",
                        "suit": "塑绘.开光.沐浴.冠笄.会亲友.作灶.放水.造畜椆栖",
                        "dayOfYear": 31,
                        "weekOfYear": 5,
                        "constellation": "天蝎座",
                        "indexWorkDayOfMonth": 1
                    }
                ]
            },
            ...中间隐藏了02月到11月的数据
            {
                "month": 12,
                "days": [
                    {
                        "date": "2018-12-01",
                        "weekDay": 6,
                        "yearTips": "戊戌",
                        "type": 1,
                        "chineseZodiac": "狗",
                        "typeDes" : "休息日",
                        "solarTerms": "小雪后",
                        "avoid": "作灶.治病",
                        "lunarCalendar": "10-24",
                        "suit": "祭祀.祈福.订盟.纳采.裁衣.拆卸.修造.动土.起基.安床.移徙.入宅.安香.入殓.移柩.安葬.谢土.赴任.进人口.会亲友",
                        "dayOfYear": 335,
                        "weekOfYear": 48,
                        "constellation": "天蝎座",
                        "indexWorkDayOfMonth": 1
                    },
                    ...中间隐藏了"2018-12-02"~"2018-12-30"的数据
                    {
                        "date": "2018-12-31",
                        "weekDay": 1,
                        "yearTips": "戊戌",
                        "type": 0,
                        "chineseZodiac": "狗",
                        "solarTerms": "冬至后",
                        "avoid": "开市.破土",
                        "lunarCalendar": "10-25",
                        "suit": "祭祀.沐浴.安床.纳财.畋猎.捕捉",
                        "dayOfYear": 365,
                        "weekOfYear": 1,
                        "constellation": "天蝎座",
                        "indexWorkDayOfMonth": 1
                    }
                ]
            }
        ]
    }

指定年份指定类型的所有的节假日及万年历信息

  • 接口说明: 获取指定月份的节假日及万年历信息

  • 接口地址: [HOST]/holiday/list/year/{date}/{type} 【例如: [HOST]/holiday/list/year/2018/rest】

  • 参数说明: date 查询的月份 格式 yyyy (只有年份),type 需要查询的类型{可选值:类型 workday 工作日 holiday 节假日 rest 休息日 festival 节日}

  • 返回数据:

    • month: 当前月份
    • year: 当前年份
      • date: 当前日期
      • weekDay: 当前周第几天 1-周一 2-周二 ... 7-周日
      • yearTips: 天干地支纪年法描述 例如:戊戌
      • type: 类型 0 工作日 1 假日 2 节假日
      • typeDes: 类型描述 比如 国庆,休息日,工作日
      • chineseZodiac: 属相 例如:狗
      • solarTerms: 节气描述 例如:小雪
      • lunarCalendar: 农历日期
      • suit: 宜事项
      • dayOfYear: 这一年的第几天
      • weekOfYear: 这一年的第几周
      • constellation: 星座
      • indexWorkDayOfMonth: 如果当前是工作日 则返回是当前月的第几个工作日,否则返回0
  • 数据样例

    {
        "code": 1,
        "msg": "数据返回成功,域名已经成功备案,为了更优雅的调用,不久后将废弃8091端口,请尽快使用新域名直接调用,多有不便敬请谅解",
        "data": [
            {
                "month": 1,
                "year": 2018,
                "days": [
                    {
                        "date": "2018-01-06",
                        "weekDay": 6,
                        "yearTips": "丁酉",
                        "type": 1,
                        "typeDes": "休息日",
                        "chineseZodiac": "鸡",
                        "solarTerms": "小寒后",
                        "avoid": "嫁娶.开市.入宅.安床.破土.安葬",
                        "lunarCalendar": "冬月廿",
                        "suit": "祭祀.斋醮.纳财.捕捉.畋猎",
                        "dayOfYear": 6,
                        "weekOfYear": 1,
                        "constellation": "天蝎座",
                        "indexWorkDayOfMonth": 1
                    },
                    ...中间还有些数据没有显示...
                    {
                        "date": "2018-01-28",
                        "weekDay": 7,
                        "yearTips": "丁酉",
                        "type": 1,
                        "typeDes": "休息日",
                        "chineseZodiac": "鸡",
                        "solarTerms": "大寒后",
                        "avoid": "祈福.嫁娶.造庙.安床.谢土",
                        "lunarCalendar": "腊月十二",
                        "suit": "纳采.订盟.祭祀.求嗣.出火.塑绘.裁衣.会亲友.入学.拆卸.扫舍.造仓.挂匾.掘井.开池.结网.栽种.纳畜.破土.修坟.立碑.安葬.入殓",
                        "dayOfYear": 28,
                        "weekOfYear": 4,
                        "constellation": "天蝎座",
                        "indexWorkDayOfMonth": 1
                    }
                ]
            },
            ...中间有2月到11月的数据没有展示...
            {
                "month": 12,
                "year": 2018,
                "days": [
                    {
                        "date": "2018-12-01",
                        "weekDay": 6,
                        "yearTips": "戊戌",
                        "type": 1,
                        "typeDes": "休息日",
                        "chineseZodiac": "狗",
                        "solarTerms": "小雪后",
                        "avoid": "作灶.治病",
                        "lunarCalendar": "十月廿四",
                        "suit": "祭祀.祈福.订盟.纳采.裁衣.拆卸.修造.动土.起基.安床.移徙.入宅.安香.入殓.移柩.安葬.谢土.赴任.进人口.会亲友",
                        "dayOfYear": 335,
                        "weekOfYear": 48,
                        "constellation": "天蝎座",
                        "indexWorkDayOfMonth": 1
                    },
                    ...中间还有些数据没有显示...
                    {
                        "date": "2018-12-30",
                        "weekDay": 7,
                        "yearTips": "戊戌",
                        "type": 1,
                        "typeDes": "元旦",
                        "chineseZodiac": "狗",
                        "solarTerms": "冬至后",
                        "avoid": null,
                        "lunarCalendar": "冬月廿四",
                        "suit": "塑绘.斋醮.出行.拆卸.解除.修造.移徙.造船.入殓.除服.成服.移柩.启攒.修坟.立碑.谢土",
                        "dayOfYear": 364,
                        "weekOfYear": 52,
                        "constellation": "天蝎座",
                        "indexWorkDayOfMonth": 1
                    }
                ]
            }
        ]
    }

获取最近节日信息

  • 接口说明: 获取最近前后七个节日信息

  • 接口地址: [HOST]/holiday/recent/list 【例如: [HOST]/holiday/recent/list】

  • 参数说明:

  • 返回数据:

    • date: 节日日期
    • lunarDate: 节日农历日期
    • holidayName: 节日名称
    • residueDays: 距离今日的天数,已经过的节日为负数
    • lunarHoliday: 是否是农历节日
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "date": "2019年07月07日",
                "lunarDate": "2019年06月05日",
                "holidayName": "国际合作节",
                "residueDays": -34,
                "lunarHoliday": false
            },
            ...这里只显示了条
        ]
    }

三、全国城市列表(全国地级市API,数据来源国家统计局),世界城市列表

全国城市列表

  • 接口说明: 获取全国城市列表信息

  • 接口地址: [HOST]/address/list

  • 参数说明: 无参

  • 返回数据:

    • code: 省/市/区编号
    • name: 省/市/区名称
    • pchilds: 市列表
    • cchilds: 区列表
  • 数据样例:

    {
        "code":1,
        "msg":"数据返回成功",
        "data":[
            {
                "code":"130000",
                "name":"河北省",
                "pchilds":[
                    {
                        "code":"130100",
                        "name":"石家庄市",
                        "cchilds":[
                            {
                                "code":"130101",
                                "name":"市辖区"
                            },
                            {
                                "code":"130102",
                                "name":"长安区"
                            },
                            ...这里只显示了两个区...
                        ]
                    },
                    {
                        "code":"130200",
                        "name":"唐山市",
                        "cchilds":[
                            {
                                "code":"130201",
                                "name":"市辖区"
                            },
                            {
                                "code":"130202",
                                "name":"路南区"
                            },
                            ...这里只显示了两个区...
                        ]
                    },
                    ...这里只显示了两个市...
                ]
            }
            ...这里只显示了个省...
        ]
    }

搜索全国城市列表

  • 接口说明: 搜索全国城市列表信息

  • 接口地址: [HOST]/address/search 【例如: [HOST]/address/search?type=1&value=深圳】

  • 参数说明:

    • type: 类型 0-查询省份 1-查询城市
    • value: 被查询的省份或者城市名称
  • 返回数据:

    • code: 省/市/区编号
    • name: 省/市/区名称
    • pchilds: 市列表
    • cchilds: 区列表
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "code": "440000",
                "name": "广东省",
                "pchilds": [
                    {
                        "code": "440300",
                        "name": "深圳市",
                        "cchilds": [
                            {
                                "code": "440301",
                                "name": "市辖区"
                            },
                            {
                                "code": "440303",
                                "name": "罗湖区"
                            },
                            ...这里只显示了两个区...
                        ]
                    }
                ]
            }
        ]
    }

世界级国家城市列表

  • 接口说明: 获取世界级国家城市列表(2019年05月15日新增接口)

  • 接口地址: [HOST]/address/v2/list

  • 参数说明: 无参

  • 返回数据:

    • code: 省/市/区编号
    • name: 省/市/区名称
    • clist: 省/市列表
    • pchilds: 市列表
    • cchilds: 区列表
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "name": "**",
                "code": "1",
                "clist": [
                    {
                        "code": "110000",
                        "name": "北京市",
                        "pchilds": [
                            {
                                "code": "110100",
                                "name": "市辖区",
                                "cchilds": [
                                    {
                                        "code": "110101",
                                        "name": "东城区"
                                    },
                                    {
                                        "code": "110102",
                                        "name": "西城区"
                                    },
                                    ...这里只显示了两个区...
                                ]
                            }
                        ]
                    }
                  	...这里只显示了个省/市...
                 ]
            },
          	{
        				"name": "阿尔巴尼亚",
        				"code": "ALB",
        				"clist": [
            				{
                				"code": "",
                				"name": "市辖区",
                				"pchilds": [
                    				{
                        				"code": "EL",
                        				"name": "爱尔巴桑",
                        				"cchilds": null
                    				},
                    				{
                        				"code": "DI",
                        				"name": "迪勃拉",
                        				"cchilds": null
                    				}
                     				...这里只显示了一个省/市... 
                        ]
                    }
            		]
            }
         ]
    }

四、IP地址信息

获取访问者的ip地址信息

  • 接口说明: 获取访问者的ip地址信息,先获取您的ip地址,再进行解析

  • 接口地址: [HOST]/ip/self

  • 参数说明: 无参

  • 返回数据:

    • ip: 访问者的ip地址
    • province: 省份
    • provinceId: 省份id
    • city: 城市
    • cityId: 城市id
    • isp: 网络服务商名称 例如 电信
    • desc: 拼接好的描述信息
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "ip": "119.123.72.166",
            "province": "广东省",
            "provinceId": 440000,
            "city": "深圳市",
            "cityId": 440300,
            "isp": "电信",
            "desc": "广东省深圳市 电信"
        }
    }

获取指定ip的ip地址信息

  • 接口说明: 获取指定ip的ip地址信息

  • 接口地址: [HOST]/ip/aim_ip?ip=? 【例如: [HOST]/ip/aim_ip?ip=119.123.72.166】

  • 参数说明: ip 被查询的ip地址 需保证是正确的ip地址格式

  • 返回数据:

    • ip: 访问者的ip地址
    • province: 省份
    • provinceId: 省份id
    • city: 城市
    • cityId: 城市id
    • isp: 网络服务商名称 例如 电信
    • desc: 拼接好的描述信息
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "ip": "119.123.72.166",
            "province": "广东省",
            "provinceId": 440000,
            "city": "深圳市",
            "cityId": 440300,
            "isp": "电信",
            "desc": "广东省深圳市 电信"
        }
    }

五、小工具

获取不重复长ID

  • 接口说明: 获取不重复长ID信息

  • 接口地址: [HOST]/tools/no_repeat_id/long

  • 参数说明: 无参

  • 返回数据:

    • id: 不重复16位字符id
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "id": "8a2a789976e64a1c9455ebd90853d4c6"
        }
    }

获取不重复短ID

  • 接口说明: 获取不重复短ID信息

  • 接口地址: [HOST]/tools/no_repeat_id/short

  • 参数说明: 无参

  • 返回数据:

    • id: 不重复8位字符id
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "id": "jlazntmtjrvcrpnb"
        }
    }

获取服务器时间

  • 接口说明: 获取服务器时间

  • 接口地址: [HOST]/tools/system/time

  • 参数说明: 无参

  • 返回数据:

    • time: 服务器当前时间戳
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "time": 1562063265883
        }
    } 

六、天气信息

获取特定城市今日天气

  • 接口说明: 获取特定城市今日天气信息

  • 接口地址: [HOST]/weather/current/{城市名} 【例如: [HOST]/weather/current/深圳市】

  • 参数说明: {城市名} 传入你需要查询的城市,请尽量传入完整值,否则系统会自行匹配,可能会有误差

  • 返回数据:

    • address: 城市具体信息,比如 “广东省 深圳市”
    • cityCode: 城市code
    • temp: 温度值
    • weather: 天气描述,具体描述请查看附件,天气描述清单
    • windDirection: 风向描述,具体描述请查看附件,风向表清单
    • windPower: 风力描述,具体描述请查看附件,风力表清单
    • humidity: 湿度值
    • reportTime: 此次天气发布时间
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "address": "广东省 深圳市",
            "cityCode": "440300",
            "temp": "18℃",
            "weather": "小雨",
            "windDirection": "东北",
            "windPower": "≤3级",
            "humidity": "92%",
            "reportTime": "2018-11-27 22:40:53"
        }
    }

获取特定城市今天及未来天气

  • 接口说明: 获取特定城市今天及未来天气信息

  • 接口地址: [HOST]/weather/forecast/{城市名} 【例如: [HOST]/weather/forecast/深圳市】

  • 参数说明: {城市名} 传入你需要查询的城市,请尽量传入完整值,否则系统会自行匹配,可能会有误差

  • 返回数据:

    • address: 城市具体信息,比如 “广东省 深圳市”
    • cityCode: 城市code
    • reportTime: 此次天气发布时间
    • forecasts: 今天及未来天气列表
      • date: 日期
      • dayOfWeek: 星期
      • dayWeather: 白天天气描述,具体描述请查看附件,天气描述清单
      • nightWeather: 晚上天气描述,具体描述请查看附件,天气描述清单
      • dayTemp: 白天温度
      • nightTemp: 晚上温度
      • dayWindDirection: 白天风向,具体描述请查看附件,风向表清单
      • nightWindDirection: 晚上风向,具体描述请查看附件,风向表清单
      • dayWindPower: 白天风力,具体描述请查看附件,风力表清单
      • nightWindPower: 晚上风力,具体描述请查看附件,风力表清单
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "address": "广东省 深圳市",
            "cityCode": "440300",
            "reportTime": "2018-11-27 22:40:53",
            "forecasts": [
                {
                    "date": "2018-11-27",
                    "dayOfWeek": "2",
                    "dayWeather": "阵雨",
                    "nightWeather": "小雨",
                    "dayTemp": "22℃",
                    "nightTemp": "17℃",
                    "dayWindDirection": "无风向",
                    "nightWindDirection": "无风向",
                    "dayWindPower": "≤3级",
                    "nightWindPower": "≤3级"
                },
                ...这里只显示了条数据...
            ]
        }
    }

七、笑话段子

分页获取笑话段子列表

  • 特别说明: 此接口的数据来源是我的另外一个产品【段子乐】,目前Android客户端已经在各大应用市场上架,定期更新数据到此服务。本服务目前只开放纯文本段子,后期看情况开放搞笑短视频和搞笑图片的接口。

  • 接口说明: 分页获取笑话段子列表

  • 接口地址: [[HOST]/jokes/list 【例如: [HOST]/jokes/list?page=1】

  • 参数说明: page 分页

  • 返回数据:

    • page: 当前页数
    • totalCount: 总数量
    • totalPage: 总页数
    • limit: 每页数量
    • list: 每页具体数据
      • content: 段子内容
      • updateTime: 更新时间
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "page": 2,
            "totalCount": 9590,
            "totalPage": 959,
            "limit": 10,
            "list": [
                {
                    "content": "儿子:“爸爸,为什么王叔叔那么喜欢吃辣”爸爸:“你怎么知道王叔叔喜欢吃辣?”儿子:“别人都叫我妈妈为辣妈,我经常看到王叔叔抱着我妈妈又亲又啃”爸爸:“尼玛”",
                    "updateTime": "2018-11-03 09:45:28"
                },
                ...这里只显示了条数据...
            ]
        }
    }

随机获取笑话段子列表

  • 特别说明: 此接口的数据来源是我的另外一个产品【段子乐】,目前Android客户端已经在各大应用市场上架,定期更新数据到此服务。本服务目前只开放纯文本段子,后期看情况开放搞笑短视频和搞笑图片的接口。

  • 接口说明: 随机获取笑话段子列表

  • 接口地址: [[HOST]/jokes/list/random 【例如: [HOST]/jokes/list/random】

  • 参数说明: 无参

  • 返回数据:

    • content: 段子内容
    • updateTime: 更新时间
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "content": "朋友问我,如果在这个时代做个普通人,你最想做什么样的。我说,我想做个皇城根底下的社会闲散人员,好吃懒做,游手好闲,靠着祖上的余荫收点租子过日子。",
                "updateTime": "2018-04-30 13:45:44"
            },
            ...这里只显示了条数据...
        ]
    }

八、生成二维码

生成单一二维码

  • 接口说明: 根据传入的内容生成二维码,可以选择获取二维码下载链接,也可以直接获取图片的Base64字符串自己解析(注:Base64字符串前面默认添加了“data:image/jpg;base64,”,取值的时候请根据需要对这个内容进行处理)。

  • 接口地址: [HOST]/qrcode/create/single 【例如: [HOST]/qrcode/create/single?content=你好&size=500&type=0】

  • 参数说明: content:生成二维码的内容 size:生成二维码的大小(不传默认为500)type:你希望返回二维码的类型:(0=下载链接 1=base64字符串)

  • 返回数据:

    • qrCodeUrl: 如果type=0 则此参数会有值,且此值会返回二维码的下载链接
    • content: 此二维码所代表的内容
    • type: 生成的二维码的输出方式 (0=下载链接 1=base64字符串)
    • qrCodeBase64: 如果type=1 则此参数会有值,且此值会返回二维码的base64字符串(注:Base64字符串前面默认添加了“data:image/jpg;base64,”,取值的时候请根据需要对这个内容进行处理)
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "qrCodeUrl": "http://www.mxnzp.com/api_file/qrcode/7/2/d/d/0/9/a/e/327588b1ddb44cf7a95e43d7ad2f5b90.png",
            "content": "你好",
            "type": 0,
            "qrCodeBase64": null
        }
    }

生成带logo二维码

  • 接口说明: 根据传入的内容生成带logo的二维码,可以选择获取二维码下载链接,也可以直接获取图片的Base64字符串自己解析(注:Base64字符串前面默认添加了“data:image/jpg;base64,”,取值的时候请根据需要对这个内容进行处理)。

  • 请求方法: POST

  • 接口地址: [HOST]/qrcode/create/logo 【例如: [HOST]/qrcode/create/logo?content=你好&size=600&logo_size=500&type=0&logo_img=logo图片】

  • 参数说明: content:生成二维码的内容 size:生成二维码的大小(不传默认为500)type:你希望返回二维码的类型:(0=下载链接 1=base64字符串) logo_size:logo的大小(不传默认为而二维码大小的1/5)logo_img:嵌入在二维码中的logo图片文件,使用post请求上传至服务器

  • 返回数据:

    • qrCodeUrl: 如果type=0 则此参数会有值,且此值会返回二维码的下载链接
    • content: 此二维码所代表的内容
    • type: 生成的二维码的输出方式 (0=下载链接 1=base64字符串)
    • qrCodeBase64: 如果type=1 则此参数会有值,且此值会返回二维码的base64字符串(注:Base64字符串前面默认添加了“data:image/jpg;base64,”,取值的时候请根据需要对这个内容进行处理)
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "qrCodeUrl": "http://127.0.0.1:8080/api_file/qrcode/d/8/f/7/3/a/1/8/ff1ea758421647ca9f96136f6298aac8.png",
            "content": "你好",
            "type": 0,
            "qrCodeBase64": null
        }
    }

九、条形码相关

生成指定条形码

  • 接口说明: 根据内容生成指定的条形码。

  • 接口地址: [HOST]/barcode/create 【例如: [HOST]/barcode/create?content=6902538005141&width=500&height=300&type=0】

  • 参数说明: content:需要生成二维码的商品code值;width:生成的图片宽度,默认500;height:生成图片的高度,默认300;type=0:返回类型,0-生成条形码图片的地址链接 1-生成条形码图片的base64字符串(注:Base64字符串前面默认添加了“data:image/jpg;base64,”,取值的时候请根据需要对这个内容进行处理)

  • 返回数据:

    • content: 图片对应的商品code值
    • barCodeUrl: 如果type=0 则此参数会有值,且此值会返回条形码的下载链接
    • barCodeBase64: 如果type=1 则此参数会有值,且此值会返回条形码的base64字符串(注:Base64字符串前面默认添加了“data:image/jpg;base64,”,取值的时候请根据需要对这个内容进行处理)
    • type: 对应类型
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "barCodeUrl": "http://127.0.0.1:8080/api_file/barcode/d/e/7/c/e/d/8/9ed3dda9026d4be2a4e9a71c7e235314.png",
            "content": "1232344122342",
            "type": 0,
            "barCodeBase64": null
        }
    }

获取条形码对应的商品信息

  • 接口说明: 根据条形码中对应的商品code获取对应的商品信息。

  • 接口地址: [HOST]/barcode/goods/details 【例如: [HOST]/barcode/goods/details?barcode=6902538005141】

  • 参数说明: barcode:扫面条形码后的商品code

  • 返回数据:

    • goodsName: 商品名称
    • barcode: 商品对应的条形码code
    • price: 预估价格
    • brand: 品牌
    • supplier: 厂商
    • standard: 规格
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "goodsName": "脉动维生素饮料(水蜜桃口味)600ml",
            "barcode": "6902538005141",
            "price": "3.80",
            "brand": "达能",
            "supplier": "达能(**)食品饮料有限公司",
            "standard": "600ml"
        }
    }

十、生成随机图片验证码

生成随机图片验证码

  • 接口说明: 生成随机长度的图片验证码。

  • 接口地址: [HOST]/verifycode/code 【例如: [HOST]/verifycode/code?len=5&type=0】

  • 参数说明: len:生成验证码的长度,不传默认5位,type=0:返回类型,0-生成图片的地址链接 1-生成验证码图片的base64字符串(注:Base64字符串前面默认添加了“data:image/jpg;base64,”,取值的时候请根据需要对这个内容进行处理)

  • 返回数据:

    • verifyCode: 图片对应的验证码的值
    • verifyCodeImgUrl: 如果type=0 则此参数会有值,且此值会返回验证码的下载链接
    • verifyCodeBase64: 如果type=1 则此参数会有值,且此值会返回验证码的base64字符串(注:Base64字符串前面默认添加了“data:image/jpg;base64,”,取值的时候请根据需要对这个内容进行处理)
    • whRatio: 验证码图片大小的宽高比
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "verifyCode": "jcyJG",
            "verifyCodeImgUrl": "http://127.0.0.1:8080/api_file/varitycode/a/6/d/a/9/8/c/2/592da008c864486396b9a2a68110d05e.jpg",
            "verifyCodeBase64": null,
            "whRatio": "225,80"
        }
    }

十一、世界电话区号列表

世界电话区号列表

  • 接口说明: 获取世界电话区号列表。

  • 接口地址: [HOST]/phone_code/list

  • 参数说明:

  • 返回数据:

    • zhCn: 中文名称
    • enUs: 英文名称
    • phoneCode: 电话区号
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "zhCn": "**",
                "enUs": "China",
                "phoneCode": "+86"
            },
            {
                "zhCn": "澳门",
                "enUs": "Macao",
                "phoneCode": "+853"
            },
            {
                "zhCn": "阿富汗",
                "enUs": "Afghanistan",
                "phoneCode": "+93"
            }
          	...这里只显示了三条数据...
        ]
    }

十二、音乐相关接口

获取每日音乐推荐列表

  • 接口说明: 获取每日音乐推荐列表。

  • 接口地址: [HOST]/music/recommend/list 【例如: [HOST]/music/recommend/list】

  • 参数说明:

  • 返回数据:

    • pic_huge: 最大的图片地址
    • ting_uid: 歌手id
    • si_proxycompany: 公司信息
    • author: 歌手姓名
    • info: 音乐描述
    • album_title: 专辑名称
    • title: 音乐名称
    • language: 音乐语言
    • pic_big: 歌曲大图
    • pic_singer:歌手图片
    • publishtime: 发布时间
    • pic_premium: 歌曲图片-中
    • pic_small: 歌曲图片-小
    • song_id: 歌曲id,查询歌曲详情需要用到
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "pic_huge": "http://qukufile2.qianqian.com/data2/pic/282c925608440af3e1a85b8c1565c88e/70303/70303.jpg@s_2,w_1000,h_1000",
                "ting_uid": "1108",
                "si_proxycompany": "滚石国际音乐股份有限公司",
                "author": "成龙",
                "info": "电影《黄飞鸿Ⅱ之男儿当自强》主题曲",
                "album_title": "成龙超级精装大戏主题曲",
                "title": "男儿当自强",
                "language": "国语",
                "pic_big": "http://qukufile2.qianqian.com/data2/pic/282c925608440af3e1a85b8c1565c88e/70303/70303.jpg@s_2,w_150,h_150",
                "pic_singer": "",
                "publishtime": "1995-01-21",
                "pic_premium": "http://qukufile2.qianqian.com/data2/pic/282c925608440af3e1a85b8c1565c88e/70303/70303.jpg@s_2,w_500,h_500",
                "song_id": "228311",
                "pic_small": "http://qukufile2.qianqian.com/data2/pic/282c925608440af3e1a85b8c1565c88e/70303/70303.jpg@s_2,w_90,h_90"
            }
            ...这里只显示了条数据...
        ]
    }

获取榜单列表

  • 接口说明: 获取每日音乐推荐列表。

  • 接口地址: [HOST]/music/order/list 【例如: [HOST]/music/order/list】

  • 参数说明:

  • 返回数据:

    • name: 榜单名称
    • type: 榜单类型,查询榜单歌曲列表需要用到
    • comment: 榜单描述
    • pic_s192: 榜单图片1
    • pic_s444: 榜单图片2
    • pic_s260: 榜单图片3
    • pic_s210: 榜单图片4
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "name": "热歌榜",
                "type": 2,
                "comment": "该榜单是根据音乐平台歌曲每周播放量自动生成的数据榜单,统计范围为音乐平台上的全部歌曲,每日更新一次",
                "pic_s192": "图片链接",
                "pic_s444": "图片链接",
                "pic_s260": "图片链接",
                "pic_s210": "图片链接"
            }
            ...这里只显示了条数据...
        ]
    }

获取指定榜单的歌曲列表

  • 接口说明: 获取指定榜单类型的歌曲列表。需要传入榜单类型type

  • 接口地址: [HOST]/music/order/song/list 【例如: [HOST]/music/order/song/list?type=2&page=1】

  • 参数说明: type:榜单列表中的榜单类型;page:页数(从1开始)

  • 返回数据:

    • language: 音乐语言
    • publishtime: 发布时间
    • pic_big: 音乐大图地址
    • country: 音乐所属国家
    • lrclink: 歌词地址
    • file_duration: 音乐时长
    • si_proxycompany: 公司信息
    • song_id: 音乐id,查询音乐详情需要
    • title: 音乐名称
    • ting_uid: 歌手id,查询歌手信息可用
    • author: 歌手姓名
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "page": 1,
            "totalCount": 1267,
            "totalPage": 127,
            "limit": 10,
            "list": [
                {
                    "language": "国语",
                    "publishtime": "2018-07-26",
                    "pic_big": "http://qukufile2.qianqian.com/data2/pic/8d356491f24692ff802cc49c80f51fee/612356223/612356223.jpg@s_2,w_150,h_150",
                    "pic_small": "http://qukufile2.qianqian.com/data2/pic/8d356491f24692ff802cc49c80f51fee/612356223/612356223.jpg@s_2,w_90,h_90",
                    "country": "内地",
                    "lrclink": "http://qukufile2.qianqian.com/data2/lrc/3bfe46c3621abf2bc89f50969a74c9a2/612356232/612356232.lrc",
                    "file_duration": null,
                    "si_proxycompany": "星空盛典影业(北京)有限公司",
                    "song_id": "601427388",
                    "title": "卡路里(电影《西虹市首富》插曲)",
                    "ting_uid": "340442495",
                    "author": "火箭少女101"
                }
                ...这里只显示了条数据...
            ]
        }
    }

搜索歌曲

  • 接口说明: 搜索歌曲

  • 接口地址: [HOST]/music/song/search 【例如: [HOST]/music/song/search?keyWord=稻香&page=1】

  • 参数说明: keyWord:被搜索的歌曲关键字,page:页数

  • 返回数据:

    • id: 音乐id,查询音乐详情需要
    • songName: 音乐名称
    • albumName: 专辑名称
    • artistName: 歌手姓名
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "page": 1,
            "totalCount": 18,
            "totalPage": 1,
            "limit": 30,
            "list": [
                {
                    "songName": "稻香",
                    "artistName": "周杰伦",
                    "albumName": "《魔杰座》",
                    "id": "1390840"
                }
              	...这里只显示了条数据...
            ]
        }
    }

获取歌曲详情

  • 接口说明: 根据歌曲id获取歌曲详情

  • 接口地址: [HOST]/music/song/detail 【例如: [HOST]/music/song/detail?songId=114921778】

  • 参数说明: songId:被搜索的歌曲id

  • 返回数据:

    • id: 音乐id,查询音乐详情需要
    • songName: 音乐名称
    • albumName: 专辑名称
    • artistName: 歌手姓名
    • songPic: 歌曲图片
    • lrcLink: 歌词地址
    • time: 歌曲时长/秒
    • songLink: 歌曲下载地址
    • format: 歌曲格式
    • rate: 歌曲rate
    • size: 歌曲文件大小
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "songName": "活出个样给自己看",
            "artistName": "衡越",
            "albumName": "圆梦",
            "songPic": "http://qukufile2.qianqian.com/data2/pic/09F3D02F6BF46E1425A81A0E6744B1B8/252053022/252053022.jpg@s_2,w_300,h_300",
            "lrcLink": "http://qukufile2.qianqian.com/data2/lrc/f3eb5904d6294625313cd35042c11a4b/601822333/601822333.lrc",
            "time": 131,
            "songLink": "http://zhangmenshiting.qianqian.com/data2/music/c5d8ff96a500d5bce48b0994ad72f367/601820410/114921778208800128.mp3?xcode=8f0f22538cd02392cc3224dc97e4d7a9",
            "format": "mp3",
            "rate": 128,
            "size": 2102206
        }
    }

搜索歌手

  • 接口说明: 搜索歌手信息

  • 接口地址: [HOST]/music/singer/search 【例如: [HOST]/music/singer/search?keyWord=周杰伦】

  • 参数说明: keyWord:被搜索的歌手关键字

  • 返回数据:

    • singerId: 歌手id,查询歌手详情需要
    • singerPic: 歌手图片
    • singerName: 歌手姓名
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "singerName": "周杰伦",
                "singerId": "7994",
                "singerPic": "http://qukufile2.qianqian.com/data2/pic/046d17bfa056e736d873ec4f891e338f/540336142/540336142.jpg@s_2,w_48,h_48"
            }
            ...这里只显示了条数据...
        ]
    }

获取歌手详情

  • 接口说明: 通过歌手id获取歌手详情

  • 接口地址: [HOST]/music/singer/detail 【例如: [HOST]/music/singer/detail?singerId=340442495】

  • 参数说明: singerId:被搜索的歌手id

  • 返回数据:

    • singerId: 歌手id
    • stature: 身高
    • avatar: 头像
    • constellation: 星座
    • intro: 介绍
    • company: 公司
    • country: 国际
    • birth: 生日
    • name: 姓名
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "stature": "",
            "avatar": "http://qukufile2.qianqian.com/data2/pic/6f1e938177547e7c337cc50463f8f2ce/610195446/610195446.jpg@s_2,w_500,h_500",
            "constellation": "巨蟹",
            "intro": "火箭少女101是由哇唧唧哇娱乐于2018年推出的**内地女子演唱组合,由孟美岐、吴宣仪、杨超越、段奥娟、Yamy、赖美云、张紫宁、杨芸晴、李紫婷、傅菁、徐梦洁十一位成员组成 。\n\n2018年6月23日,11位成员在腾讯视频女团青春成长节目《创造101》中获胜,成功获得成团资格;同日,发行单曲《Rocket Girls》;24日,通过湖南卫视《快乐**毕业歌会》完成成团首秀;7月12日,首部团体综艺节目《火箭少女101研究所》首播;27日,为电影《西虹市首富》演唱插曲《卡路里》。",
            "company": "",
            "country": "**",
            "artist_id": "601427383",
            "birth": "2018-06-23",
            "name": "火箭少女101",
            "singerId": "340442495"
        }
    }

获取歌手所有的歌曲列表

  • 接口说明: 通过歌手id获取歌手所有的单曲列表

  • 接口地址: [HOST]/music/singer/song/list 【例如: [HOST]/music/singer/song/list?singerId=340442495&page=1】

  • 参数说明: singerId:被查询的歌手id ;page:页数(从1开始)

  • 返回数据:

    • language: 音乐语言
    • publishtime: 发布时间
    • pic_big: 音乐大图地址
    • country: 音乐所属国家
    • lrclink: 歌词地址
    • file_duration: 音乐时长
    • si_proxycompany: 公司信息
    • song_id: 音乐id,查询音乐详情需要
    • title: 音乐名称
    • ting_uid: 歌手id,查询歌手信息可用
    • author: 歌手姓名
  • 数据样例:

  • {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "page": 1,
            "totalCount": 4,
            "totalPage": 1,
            "limit": 10,
            "list": [
                {
                    "language": "国语",
                    "publishtime": "2018-07-26",
                    "pic_big": "http://qukufile2.qianqian.com/data2/pic/8d356491f24692ff802cc49c80f51fee/612356223/612356223.jpg@s_2,w_150,h_150",
                    "pic_small": "http://qukufile2.qianqian.com/data2/pic/8d356491f24692ff802cc49c80f51fee/612356223/612356223.jpg@s_2,w_90,h_90",
                    "country": "内地",
                    "lrclink": "http://qukufile2.qianqian.com/data2/lrc/3bfe46c3621abf2bc89f50969a74c9a2/612356232/612356232.lrc",
                    "file_duration": "232",
                    "si_proxycompany": "星空盛典影业(北京)有限公司",
                    "song_id": "601427388",
                    "title": "卡路里(电影《西虹市首富》插曲)",
                    "ting_uid": "340442495",
                    "author": "火箭少女101"
                }
                ...这里只显示了条数据...
            ]
        }
    }

十三、手机号码归属地

手机号码归属地查询

  • 接口说明: 手机号码归属地查询。

  • 接口地址: [HOST]/mobile_location/aim_mobile 【例如: [HOST]/mobile_location/aim_mobile?mobile=13227293721(这不是我手机号,不要加我微信撩我)】

  • 参数说明: mobile:目标手机号码

  • 返回数据:

    • mobile: 目标手机号
    • province: 归属地省份
    • carrier: 归属地描述
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "mobile": "13227293721",
            "province": "湖北",
            "carrier": "湖北联通"
        }
    }

十四、在线自定义参数

特别说明

  • 使用场景: 比如App正在应用市场进行审核的时候,需要隐藏一些敏感的页面,一个敏感的功能,防止审核员看到后会让应用审核不通过,这个时候就需要一个在线自定义的参数,来告诉App当前是否是审核的敏感期,来做对应的处理。
  • 使用流程: 为了完成上面的功能,开发者需要完成以下几步,如果你不使用这个功能,可不关注如下步骤。
    • 1、联系管理员注册一个账户,因为你创建的应用需要跟账户绑定,才不会出现丢失的情况。
    • 2、创建账户成功之后,会提供一个user_id给你,这个相当于一个账户的凭证。用这个user_id调用创建一个应用接口创建一个应用,创建应用之后就可以拿到应用的productId和secret。
    • 3、有了productId和secret就可以调用给指定应用设置在线参数设置在线参数了
    • 4、设置成功之后在客户端就可以调用接口获取指定应用的在线参数来说去已设置的在线参数了。
  • 未来展望: 当然后面我会开发一个pc的管理页面,类似用户的注册,配置的设置与修改,项目的创建与管理都可在页面上进行管理,方便大家的使用

创建一个应用

  • 接口说明: 用户创建一个应用来启用在线自定义参数的功能。

  • 接口地址: [HOST]/admin/user/product/add 【例如: [HOST]/admin/user/product/add?type=1&name=测试app&desc=测试描述&user_id=您的user_id】

  • 参数说明: type:应用类型,0-移动应用 1-网页应用;name:应用名称(不可为空);desc:应用描述;user_id:用户id(这个目前不支持自己注册,需要联系管理员给你分配)

  • 返回数据:

    • productId: 应用id
    • secret: 应用secret
    • createTime: 创建时间
    • description: 应用描述
    • productName: 应用名称
    • productType: 应用类型
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "productId": "50004",
            "secret": "924d88c474994a8b88f7f62d9bc634b6",
            "createTime": "2019-07-02 18:47:06",
            "description": "测试描述",
            "productName": "测试3app",
            "productType": "网页应用"
        }
    }

获取用户创建的应用列表

  • 接口说明: 获取用户创建的所有应用列表。

  • 接口地址: [HOST]/admin/user/product/list 【例如: [HOST]/admin/user/product/add?user_id=您的user_id】

  • 参数说明: user_id:用户id(这个目前不支持自己注册,需要联系管理员给你分配)

  • 返回数据:

    • productId: 应用id
    • secret: 应用secret
    • createTime: 创建时间
    • description: 应用描述
    • productName: 应用名称
    • productType: 应用类型
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "productId": "50000",
                "secret": "7f4470ffaaf84613928ccb73d9491950",
                "createTime": "2019-07-02 14:49:40",
                "description": "测试描述",
                "productName": "测试app",
                "productType": "移动应用"
            },
          	...这里只显示了条数据...
        ]
    }

给指定应用设置在线参数

  • 接口说明: 给指定应用设置在线参数。

  • 请求方法: POST

  • 接口地址: [HOST]/remote_config/set 【例如: [HOST]/remote_config/set?user_id=您的user_id&secret=应用的secret&product_id=应用的product_id&config=eyJpc1Nob3ciOnRydWV9,注意:后面的参数写在这里只是方便查看,真的传参要放在POST请求的参数列表里面】

  • 参数说明: user_id:用户id(这个目前不支持自己注册,需要联系管理员给你分配);secret:应用的secret,可从应用列表获取;product_id:应用的product_id,可从应用列表获取;config:在线参数的值,这里建议传递json串,特别注意,这个参数需要base64加密之后传给后端,否则会出错。

  • 返回数据:

  • 数据样例:

    {
        "code": 0,
        "msg": "配置设置成功",
        "data": null
    }

获取指定应用的在线参数

  • 接口说明: 获取指定应用的在线参数。

  • 接口地址: [HOST]/remote_config/get 【例如: [HOST]/remote_config/get?user_id=您的user_id&secret=应用的secret&product_id=应用的product_id】

  • 参数说明: user_id:用户id(这个目前不支持自己注册,需要联系管理员给你分配);secret:应用的secret,可从应用列表获取;product_id:应用的product_id,可从应用列表获取;

  • 返回数据:

    • productId: 应用id
    • updateTime: 配置修改时间
    • productConfig: 应用在线参数配置信息,这里返回的数据不需要进行base64解码即可使用,如果你之前设置的是json数据,这里返回的也是json数据,你需要对productConfig的数据进行二次json解析。
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "productId": 50000,
            "productConfig": "{\"isShow\":true}",
            "updateTime": 1562054944000
        }
    }

十五、免费最新新闻

获取所有新闻类型列表

  • 接口说明: 获取所有新闻类型列表。

  • 接口地址: [HOST]/news/types 【例如: [HOST]/news/types】

  • 参数说明:

  • 返回数据:

    • typeId: 类型id,获取新闻列表需要用到
    • typeName: 类型名称描述
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "typeId": 509,
                "typeName": "财经"
            },
            {
                "typeId": 510,
                "typeName": "科技"
            },
            ...这里只显示了两个...
        ]
    }

根据新闻类型获取新闻列表

  • 接口说明: 获取所有新闻类型列表。

  • 接口地址: [HOST]/news/list【例如: [HOST]/news/list?typeId=509&page=1】

  • 参数说明: typeId:类型id,从上面的新闻类型列表中获取,page:当前页数

  • 返回数据:

    • title: 新闻标题
    • imgList: 新闻描述图片列表
    • source: 新闻来源
    • newsId: 新闻唯一id,后面查询新闻详情需要
    • digest: 新闻摘要
    • postTime: 新闻发布时间
    • title: 新闻标题
    • videoList: 新闻视频列表
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "title": "***:巩固机构改革成果 推进治理体系和能力现代化",
                "imgList": null,
                "source": "新华网",
                "newsId": "EJBCPBMK000189FH",
                "digest": "***在深化党和国家机构改革总结会议上强调巩固党和国家机构改革成果推进国家治理体系和治理能力现代化李克强栗战书汪洋赵乐际韩正出席王沪宁主持新华社北京7月5日电深",
                "postTime": "2019-07-05 17:45:44",
                "videoList": null
            },
            ...这里只显示条数据...
        ]
    }

根据新闻id获取新闻详情

  • 接口说明: 根据新闻id获取新闻详情。

  • 接口地址: [HOST]/news/details【例如: [HOST]/news/details?newsId=EJA5MJQ30001875N】

  • 参数说明: newsId:新闻唯一id,从上面的新闻列表中获取

  • 返回数据:

    • images: 新闻详情图片列表
    • title: 新闻详情标题
    • source: 新闻来源
    • content: 新闻详情内容
    • ptime: 新闻发布时间
    • docid: 新闻唯一id
    • cover: 新闻封面图片
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "images": [
                {
                    "position": "<!--IMG#0-->",
                    "imgSrc": "http://cms-bucket.ws.126.net/2019/07/05/86125cd7700c4bc5aa8f8bca16df66be.jpeg",
                    "size": "865*772"
                },
                ...这里只显示了张图片
            ],
            "title": "三峡大坝被传已变形将溃堤 **航天发卫星图澄清",
            "content": "<p>  近日,境外一名反华分子在他的社交账号上宣称**的三峡大坝已经变形,溃堤在即。...",
            "source": "环球时报",
            "ptime": "2019-07-05 06:22:40",
            "docid": "EJA5MJQ30001875N",
            "cover": "http://cms-bucket.ws.126.net/2019/07/05/017d16cc8d5745978c9150012ba69fe4.png"
        }
    }

十六、垃圾分类

查询垃圾分类信息

  • 接口说明: 查询指定物品垃圾分类信息。

  • 接口地址: [HOST]/rubbish/type 【例如: [HOST]/rubbish/type?name=西瓜】

  • 参数说明: name:物品名称,必传

  • 返回数据:

    • aim: 查询出来的匹配结果
      • goodsName: 物品名称
      • goodsType: 物品垃圾分类类型
    • recommendList: 推荐查询结果
      • 同上,不再赘述
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "aim": {
                "goodsName": "西瓜",
                "goodsType": "湿垃圾"
            },
            "recommendList": [
                {
                    "goodsName": "西瓜霜含片塑料铝箔包装",
                    "goodsType": "有害垃圾"
                },
                ...这里就显示了个...
            ]
        }
    }

十七、福利养眼图片

随机获取福利图片

  • 接口说明: 随机获取福利图片。

  • 接口地址: [HOST]/image/girl/list/random 【例如: [HOST]/image/girl/list/random】

  • 参数说明:

  • 返回数据:

    • imageUrl: 福利图片链接
    • imageSize: 福利图片尺寸
    • imageFileLength: 福利图片文件大小
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "imageUrl": "https://tvax3.sinaimg.cn/large/005BYqpggy1g28fwh5g7oj31hc0u0u0x.jpg",
                "imageSize": "1920x1080",
                "imageFileLength": 376155
            },
            ...这里只显示条数据...
        ]
    }

获取福利图片列表

  • 接口说明: 获取福利图片列表。

  • 接口地址: [HOST]/image/girl/list 【例如: [HOST]/image/girl/list?page=1】

  • 参数说明: page:当前页数

  • 返回数据:

    • imageUrl: 福利图片链接
    • imageSize: 福利图片尺寸
    • imageFileLength: 福利图片文件大小
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "page": 1,
            "totalCount": 10951,
            "totalPage": 1096,
            "limit": 10,
            "list": [
                {
                    "imageUrl": "https://ws1.sinaimg.cn/large/610dc034ly1fhgsi7mqa9j20ku0kuh1r.jpg",
                    "imageSize": "750x750",
                    "imageFileLength": 605716
                },
                ...这里只显示条...
            ]
        }
    }

十八、物流查询

查询支持的所有快递公司编号列表

  • 接口说明: 查询支持的所有快递公司编号列表。

  • 接口地址: [HOST]/logistics/type/list 【例如: [HOST]/logistics/type/list】

  • 参数说明:

  • 返回数据:

    • logisticsId: 快递公司编号id,后面查询物流信息需要用到
    • logisticsName: 快递公司名称
    • hot: 是否是热门快递公司
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "logisticsId": 1,
                "logisticsName": "顺丰速运",
                "hot": true
            },
            {
                "logisticsId": 2,
                "logisticsName": "百世快递",
                "hot": true
            },
            ...这里只展示了两个...
        ]
    }

根据公司名称查询对应的公司编号

  • 接口说明: 根据公司名称查询对应的公司编号。

  • 接口地址: [HOST]/logistics/type/search 【例如: [HOST]/logistics/type/search?name=韵达】

  • 参数说明: name:被查询的公司名称

  • 返回数据:

    • logisticsId: 快递公司编号id,后面查询物流信息需要用到
    • logisticsName: 快递公司名称
    • hot: 是否是热门快递公司
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "logisticsId": 6,
                "logisticsName": "韵达速递",
                "hot": true
            },
            {
                "logisticsId": 178,
                "logisticsName": "韵达快运",
                "hot": false
            }
        ]
    }

根据快递单号识别出所属快递公司编号

  • 接口说明: 根据快递单号识别出所属快递公司编号。

  • 接口地址: [HOST]/logistics/discern 【例如: [HOST]/logistics/discern?logistics_no=804967979558203287】

  • 参数说明: logistics_no:被查询的快递单号

  • 返回数据:

    • logisticNo: 快递单号
    • searchList: 搜索结果,搜索不到时列表为空
      • logisticsTypeName: 单号对应的物流公司名称
      • logisticsTypeId: 单号对应的物流公司id,后面查询物流信息需要用到
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "logisticNo": "804967979558203287",
            "searchList": [
                {
                    "logisticsTypeName": "圆通速递",
                    "logisticsTypeId": 5
                }
            ]
        }
    }

查询物流信息

  • 接口说明: 根据快递单号以及物流公司id查询物流信息。

  • 接口地址: [HOST]/logistics/details/search 【例如: [HOST]/logistics/details/search?logistics_no=804967979558203287&logistics_id=5】

  • 参数说明: logistics_no:被查询的快递单号,logistics_id:单号对应的物流id

  • 返回数据:

    • logisticNo: 快递单号
    • logisticsType: 物流公司类型名称
    • status: 物流当前状态,分别为”在途中“,”签收“,”问题件“
    • data: 物流轨迹
      • time: 时间锚点
      • desc:
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": {
            "logisticsNo": "804967979558203287",
            "logisticsType": "圆通速递",
            "status": "签收",
            "data": [
                {
                    "time": "2019-03-21 15:42:28",
                    "desc": "【河南省商丘市柘城公司】 已收件"
                },
                {
                    "time": "2019-03-21 15:42:39",
                    "desc": "【河南省商丘市柘城】 已发出 下一站 【郑州转运中心】"
                },
               ...这里只展示两条轨迹信息...
            ]
        }
    }

十九、历史上的今天

获取历史上的今天数据

  • 接口说明: 获取已经收录的历史上的今天的所有数据。

  • 接口地址: [HOST]/history/today 【例如: [HOST]/history/today?type=1】

  • 参数说明: type:是否需要详情,0:不需要详情 1:需要详情 默认值 0 可不传

  • 返回数据:

    • picUrl: 历史事件所对应的图片,可能为空
    • title: 历史事件的名称
    • year: 该历史事件发生所对应的年份
    • month: 该历史事件发生所对应的月份
    • day: 该历史事件发生所对应的日期
    • details: 历史事件的详细介绍,如果type=1,则此字段有返回值,否则不返回
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功",
        "data": [
            {
                "picUrl": "http://www.todayonhistory.com/uploadfile/2016/0909/20160909104645350.jpg",
                "title": "***逝世40周年纪念日",
                "year": "2016",
                "month": 9,
                "day": 9,
                "details": "***\r\n  1976年9月9日,**人民的领袖,伟大的无产阶级革命家、战略家和理论家,**共产党、**人民解放军和中华人民共和国的主要缔造者和领导人***逝世,享年83岁。\r\n  今天(2016年9月9日)是***逝世40周年纪念日,让我们一起回顾他的一生,缅怀这位伟人。\r\n  ..."
            }
          ...这里只显示了条...
         ]
    }

二十、简繁转换

简体与繁体的转换

  • 接口说明: 简体与繁体的相互转换。

  • 接口地址: [HOST]/convert/zh 【例如: [HOST]/convert/zh?content=当你老了&type=1】

  • 参数说明:

    • type:1 简体转繁体 2 繁体转简体
    • content:待转换的内容
  • 返回数据:

    • originContent: 原内容
    • convertContent: 转化转化的内容
  • 数据样例:

    {
        "code": 1,
        "msg": "数据返回成功!",
        "data": {
            "originContent": "当你老了",
            "convertContent": "當你老了"
        }
    }

二十一、文本翻译

文本翻译

  • 接口说明: 将一种语种翻译成另外一种语种。

  • 接口地址: [HOST]/convert/translate 【例如: [HOST]/convert/translate?content=我是一个好人&from=zh&to=en】

  • 参数说明:

    • content: 被翻译的内容
    • from: 原文语种,可选值如下
      • auto :自动检测语言,但对于非常用语种,语种自动检测可能存在误差
      • zh-中文,en-英文,yue-粤语,wyw-文言文,jp-日语,kor-韩语,fra-法语,spa-西班牙语,th-泰语,ara-阿拉伯语,ru-俄语,pt-葡萄牙语,de-德语,it-意大利语,el-希腊语,nl-荷兰语,pl-波兰语,bul-保加利亚语,est-爱沙尼亚语,dan-丹麦语,fin-芬兰语,cs-捷克语,rom-罗马尼亚语,slo-斯洛文尼亚语,swe-瑞典语,hu-匈牙利语,cht-繁体中文,vie-越南语
    • to: 被翻译的目标语种,可选值如下
      • zh-中文,en-英文,yue-粤语,wyw-文言文,jp-日语,kor-韩语,fra-法语,spa-西班牙语,th-泰语,ara-阿拉伯语,ru-俄语,pt-葡萄牙语,de-德语,it-意大利语,el-希腊语,nl-荷兰语,pl-波兰语,bul-保加利亚语,est-爱沙尼亚语,dan-丹麦语,fin-芬兰语,cs-捷克语,rom-罗马尼亚语,slo-斯洛文尼亚语,swe-瑞典语,hu-匈牙利语,cht-繁体中文,vie-越南语
  • 返回数据:

    • origin: 原内容
    • result: 被翻译后的内容
    • originLanguage: 原文语种编码
    • resultLanguage: 被翻译后的语种编码
  • 数据样例:

{
    "code": 1,
    "msg": "数据返回成功!",
    "data": {
        "origin": "我是一个好人",
        "result": "I'm a good man",
        "originLanguage": "zh",
        "resultLanguage": "en"
    }
}

二十二、汉字字典

查询单个汉字的读音和含义

  • 接口说明: 查询单个汉字的读音和含义。

  • 接口地址: [HOST]/convert/dictionary 【例如: [HOST]/convert/dictionary?content=穆】

  • 参数说明:

    • content: 被查询的汉字内容
  • 返回数据:

    • word: 原内容
    • traditional: 繁体
    • pinyin: 拼音
    • radicals: 偏旁部首
    • explanation: 汉字释义
    • strokes: 汉字笔画数
  • 数据样例:

{
    "code": 1,
    "msg": "数据返回成功!",
    "data": [
        {
            "word": "穆",
            "traditional": "穆",
            "pinyin": "mù",
            "radicals": "禾",
            "explanation": "穆 \n\n (形声。本义禾名)\n\n 同本义 \n\n 穆,禾也。--《说文》。段玉裁注盖禾有名穆者也。”\n\n 古时宗庙制度,父居左为昭,子居右为穆。参见昭穆” \n\n 辩庙祧之昭穆。--《周礼·小宗伯》。注父曰昭,子曰穆。”\n\n 代指右边 \n\n 只见贾府人分了昭穆,排班立定。--《红楼梦》\n\n 又如昭穆(左边和右边)\n\n\n\n\n\n 恭敬 \n\n 于穆清庙。--《诗·周颂·清庙》\n\n 穆穆皇皇。--《诗·大雅·假乐》\n\n 我其为王穆卜。--《书·金滕》。传\n\n 穆mù\n\n ⒈和畅,美好~如清风。\n\n ⒉和睦不~。\n\n ⒊恭敬,严肃静~。肃~。~ ~皇皇(皇皇美好的样子)。",
            "strokes": 16
        }
    ]
}

二十三、每日精美语句

每日推荐精美语句

  • 接口说明: 每日推荐精美语句。
  • 接口地址: [HOST]/daily_word/recommend 【例如: [HOST]/daily_word/recommend?count=10】
  • 参数说明:
    • count: 被查询的语句条数,范围【1~20】
  • 返回数据:
    • content: 精美语句内容
    • author: 此语句的作者,不保证都有
  • 数据样例:
{
    "code": 1,
    "msg": "数据返回成功!",
    "data": [
        {
            "content": "承君此诺,必守一生。",
            "author": "锦重"
        },
      	...这里只显示了条...
    ]
}

附件

天气描述清单

  • 少云
  • 晴间多云
  • 多云
  • 有风
  • 平静
  • 微风
  • 和风
  • 清风
  • 强风/劲风
  • 疾风
  • 大风
  • 烈风
  • 风暴
  • 狂爆风
  • 飓风
  • 热带风暴
  • 中度霾
  • 重度霾
  • 严重霾
  • 阵雨
  • 雷阵雨
  • 雷阵雨并伴有冰雹
  • 小雨
  • 中雨
  • 大雨
  • 暴雨
  • 大暴雨
  • 特大暴雨
  • 强阵雨
  • 强雷阵雨
  • 极端降雨
  • 毛毛雨/细雨
  • 小雨-中雨
  • 中雨-大雨
  • 大雨-暴雨
  • 暴雨-大暴雨
  • 大暴雨-特大暴雨
  • 雨雪天气
  • 雨夹雪
  • 阵雨夹雪
  • 冻雨
  • 阵雪
  • 小雪
  • 中雪
  • 大雪
  • 暴雪
  • 小雪-中雪
  • 中雪-大雪
  • 大雪-暴雪
  • 浮尘
  • 扬沙
  • 沙尘暴
  • 强沙尘暴
  • 龙卷风
  • 浓雾
  • 强浓雾
  • 轻雾
  • 大雾
  • 特强浓雾
  • 未知

风力表清单

  • ≤3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12

风向表清单

  • 无风向
  • 东北
  • 东南
  • 西南
  • 西
  • 西北
  • 旋转不定

rolltoolsapi's People

Contributors

mzcretin avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.