ROLL

登    录

注    册

重置密码

博主-ROLL圈圈 博主-ROLL圈圈 2020年11月05 2492 字

通用免费Api使用教程

其实所有的文档内容都有在GitHub上体现,而且Github上一定是最新的内容。

https://github.com/MZCretin/RollToolsApi

What?

什么是RollToolsApi,这是一个公益项目,Roll 圈圈的意思,Tools 工具的意思,Api 接口的意思,说到底就是一个胖的像个球的我提供的一个工具类接口集合。

Why?

为什么要做这个呢?这些接口其实最开始是我自己使用的,后来也顺便提供给朋友用,再后来就直接开放出来了~并且为之购买了独立的服务器维护。说到底就是为了情怀~

How?

怎么使用呢?其实这就是一个普通的Api接口,调用方式很简单,就发送Http请求就好了,跟你在日常开发的时对接的后台接口是一样的。

其实最开始是没有任何使用门槛的,就是是谁都可以调用,也不会限速,限次数,限IP,但是慢慢的就有了一些不怀好意的人,老是来攻击服务器,服务器经常性的被搞炸,后来逼不得已,对接口的使用进行了一些限制,那就是需要你申请一个app_id和app_secret才能使用接口。但是你不用担心,申请完app_id和app_secret之后就可以畅通无阻的使用接口,没有任何限制。

什么是app_id和app_secret?

它只是一个身份的象征,代表你是自己人。

怎么申请呢?

目前只提供在小程序上进行申请(其实只是想你帮我点下广告,哈哈哈),扫描下方的二维码进入小程序(或者搜索小程序【Roll地盘】),在我的页面中申请app_id和app_secret。申请成功之后即可将app_id和app_srcret作为请求参数进行任意接口的访问了。经过很长时间的反馈,大家都说小程序里面的广告其实也挺好看的~~~~

小程序tu

怎么使用呢?

  • 在每个请求链接后面添加app_id=你的app_id&app_secret=你的app_secret两个参数,如果是POST请求,需要将两个参数放在参数列表中请求。
  • 在请求头header中添加app_id=你的app_id&app_secret=你的app_secre两个参数,更加方便【推荐方案】。

怎么检测是否正确接入?

  • 如果你没有正确接入,是没有办法获取到数据的。
  • 扫描上方小程序码(或者搜索小程序【Roll地盘】),进入我的页面,点击数据统计,这里将会显示接口的调用情况,如果配置正确,这里将会有统计数据。

出现问题怎么整?

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

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

    小程序tu
  • 给我的邮箱发邮件,说出你的问题,mxnzp_life@163.com

  • 进入上面提到的小程序,进入之后,有个客服入口,点击去也能找到我呢。

接口的通用说明

  • 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: 每页具体数据