通用免費(fèi)Api使用教程

其實(shí)所有的文檔內(nèi)容都最開(kāi)始來(lái)源于GitHub~你有空的話可以點(diǎn)個(gè)star。

項(xiàng)目地址：https://github.com/MZCretin/RollToolsApi

What？

什么是RollToolsApi，這是一個(gè)公益項(xiàng)目，Roll 圈圈的意思，Tools 工具的意思，Api 接口的意思，說(shuō)到底就是一個(gè)胖的像個(gè)球的我提供的一個(gè)工具類(lèi)接口集合。

Why？

為什么要做這個(gè)呢？這些接口其實(shí)最開(kāi)始是我自己使用的，后來(lái)也順便提供給朋友用，再后來(lái)就直接開(kāi)放出來(lái)了~ 并且為之購(gòu)買(mǎi)了獨(dú)立的服務(wù)器維護(hù)。說(shuō)到底就是為了情懷~

How？

怎么使用呢？其實(shí)這就是一個(gè)普通的Api接口，調(diào)用方式很簡(jiǎn)單，就發(fā)送http請(qǐng)求就好了，跟你在日常開(kāi)發(fā)的時(shí)對(duì)接的后臺(tái)接口是一樣的。

其實(shí)最開(kāi)始是沒(méi)有任何使用門(mén)檻的，就是是誰(shuí)都可以調(diào)用，也不會(huì)限速，限次數(shù)，限IP，但是慢慢的就有了一些不懷好意的人，老是來(lái)攻擊服務(wù)器，服務(wù)器經(jīng)常性的被搞炸，后來(lái)逼不得已，對(duì)接口的使用進(jìn)行了一些限制，那就是需要你申請(qǐng)一個(gè)app_id和app_secret才能使用接口。但是你不用擔(dān)心，申請(qǐng)完app_id和app_secret之后就可以使用平臺(tái)提供的所有接口。

接口文檔在哪里呢？

所有最新的接口文檔會(huì)在這里同步更新，接口是否下線以及新增接口都會(huì)在這里體現(xiàn)：https://www.mxnzp.com/doc/list

什么是app_id和app_secret?

它只是一個(gè)身份的象征，代表你是自己人。

怎么申請(qǐng)呢？

之前提供了沒(méi)有限制的測(cè)試app_id，但是后來(lái)這個(gè)app_id被濫用了，于是不再提供測(cè)試app_id!目前只提供在小程序上進(jìn)行申請(qǐng)（其實(shí)只是想你幫我點(diǎn)下廣告，哈哈哈），掃描下方的二維碼進(jìn)入小程序（或者搜索小程序【電點(diǎn)科技】），在我的頁(yè)面中申請(qǐng)app_id和app_secret。申請(qǐng)成功之后即可將app_id和app_srcret作為請(qǐng)求參數(shù)進(jìn)行任意接口的訪問(wèn)了。

怎么使用呢？

• ??在每個(gè)請(qǐng)求鏈接后面添加app_id=你的app_id&app_secret=你的app_secret兩個(gè)參數(shù)，如果是POST請(qǐng)求，需要將兩個(gè)參數(shù)放在參數(shù)列表中請(qǐng)求。

• ??在請(qǐng)求頭header中添加app_id=你的app_id&app_secret=你的app_secre兩個(gè)參數(shù)，更加方便【推薦方案】。

怎么檢測(cè)是否正確接入？

• ??如果你沒(méi)有正確接入，是沒(méi)有辦法獲取到數(shù)據(jù)的。

• ??掃描上方小程序碼（或者搜索小程序【電點(diǎn)科技】），進(jìn)入我的頁(yè)面，點(diǎn)擊數(shù)據(jù)統(tǒng)計(jì)，這里將會(huì)顯示接口的調(diào)用情況，如果配置正確，這里將會(huì)有統(tǒng)計(jì)數(shù)據(jù)。

• ??訪問(wèn) https://www.mxnzp.com/ ，然后用郵箱注冊(cè)一個(gè)平臺(tái)的賬號(hào)，然后在控制臺(tái)綁定你的app_id和app_secret之后也可以看到你每天的請(qǐng)求量數(shù)據(jù)

出現(xiàn)問(wèn)題怎么整？

• ??隨著使用本api用戶(hù)的增多，每一次對(duì)服務(wù)器的升級(jí)維護(hù)，都需要格外小心，否則將會(huì)影響到用戶(hù)的使用。特此創(chuàng)建了一個(gè)交流群（目前群1已滿(mǎn)，群2還有一半空間），旨在交流使用通用接口中遇到的問(wèn)題，以及其他新接口的建議，群中大佬云集，可以進(jìn)行學(xué)術(shù)交流！有新接口的誕生也方便通知大家！另外一個(gè)作用就是，如果接口需要停機(jī)維護(hù)，會(huì)提前在群中通知，以免對(duì)大家的使用帶來(lái)不便以及損失！前期開(kāi)放掃描二維碼進(jìn)群的方式讓群里多了很多發(fā)布淫穢，色情，賭博的廣告信息，現(xiàn)關(guān)閉此方式，需要加群的請(qǐng)?zhí)砑游椅⑿藕糜眩依闳肴海▊渥⑾峦ㄓ肁PI），感謝您的支持！

• 
  

• ? ? ? ? ? ? ? ? ? ? ? ??

• 
  

• ??給我的郵箱發(fā)郵件，說(shuō)出你的問(wèn)題，[email protected]

• ??在本文章下留言也可以，我們看到之后會(huì)回復(fù)的

• ??進(jìn)入上面提到的小程序，進(jìn)入之后，有個(gè)客服入口，點(diǎn)擊去也能找到我呢

我是社會(huì)的未來(lái)？

我們通常稱(chēng)學(xué)生和老師是社會(huì)的未來(lái)，所以如果你是在校學(xué)生或者老師，在你注冊(cè)完app_id之后，可以找我們申請(qǐng)賬號(hào)特權(quán)，有了這個(gè)特權(quán)，將會(huì)得到?jīng)]有任何限制的請(qǐng)求體驗(yàn)。

接口的通用說(shuō)明

• ??HOST地址：?推薦使用https接口更安全：https://www.mxnzp.com/api?之前的?http://www.mxnzp.com/api?可繼續(xù)使用不受影，我們會(huì)自動(dòng)轉(zhuǎn)到https上去！

• ??app_id和app_secret方式請(qǐng)求（擺脫被封IP的限制，可在服務(wù)器中調(diào)用接口）：

  • ??在參數(shù)中添加app_id=你的app_id&app_secret=你的app_secret

  • ??【推薦方案】在請(qǐng)求頭header中添加app_id=你的app_id&app_secret=你的app_secret

  • ??唯一獲取app_id和app_secret方式，掃描上方小程序碼進(jìn)行操作！

• ??說(shuō)明：?所有的接口都會(huì)返回如下格式的數(shù)據(jù)，具體數(shù)據(jù)包裝在data中，需要根據(jù)狀態(tài)來(lái)確定請(qǐng)求是否成功。

• ??請(qǐng)求方法：?所有的請(qǐng)求中都是大部分都是GET請(qǐng)求（如果有特殊情況，則會(huì)特殊標(biāo)明）

• ??數(shù)據(jù)返回格式：{
????"code":?1,
????"msg":?"數(shù)據(jù)返回成功",
????"data":?null
}

• ??數(shù)據(jù)返回格式說(shuō)明（下面所有接口中的數(shù)據(jù)返回都是基于data的，不再介紹code和msg，請(qǐng)知悉）：

  • ??code：?狀態(tài)碼 1 返回成功 0 返回失敗 此時(shí)，請(qǐng)關(guān)注msg錯(cuò)誤信息

  • ??msg：?提示信息，當(dāng)code返回0的時(shí)候包含錯(cuò)誤提示信息

  • ??data：?主要信息，不同接口返回的東西不一樣

• ??列表數(shù)據(jù)格式說(shuō)明（大部分列表數(shù)據(jù)都滿(mǎn)足下列格式，特殊接口除外，在此特別說(shuō)明，后面就不再贅述了）

  • ??page：?當(dāng)前頁(yè)數(shù)

  • ??totalCount：?總數(shù)量

  • ??totalPage：?總頁(yè)數(shù)

  • ??limit：?每頁(yè)數(shù)量

  • ??list：?每頁(yè)具體數(shù)據(jù)