果創(chuàng)云:如何開放自己的API接口給他人調(diào)用并限制請(qǐng)求次數(shù)?
你將學(xué)到什么?
可以幫助你實(shí)現(xiàn):將自己的API接入到果創(chuàng)云,然后創(chuàng)建子應(yīng)用給到你的客戶或你的開發(fā)者進(jìn)行接口調(diào)用,并統(tǒng)計(jì)調(diào)用次數(shù)。平臺(tái)暫時(shí)不支持線上結(jié)算,需要自己進(jìn)行線下接口調(diào)用次數(shù)的內(nèi)部結(jié)算。
預(yù)計(jì)需要開發(fā)時(shí)間:0.5天,其他步驟都可以通過(guò)界面可視化操作完成。
主要使用步驟:
1. 在果創(chuàng)云上快速接入你的API接口,生成并創(chuàng)建一個(gè)請(qǐng)求外部接口
2. 創(chuàng)建一張新表單:調(diào)用明細(xì)api_bill_list,添加字段:子應(yīng)用app_key
3. 在 客戶端管理,添加一個(gè)新的子應(yīng)用,并把子應(yīng)用app_key提供給你的開發(fā)者??梢葬槍?duì)每個(gè)子應(yīng)用設(shè)置接口總流量上限。
4. 如果還需要給你的開發(fā)者提供調(diào)用記錄賬單,可以使用 表單數(shù)據(jù)分享,為每一個(gè)開發(fā)者單獨(dú)創(chuàng)建一個(gè)分享鏈接
5. 內(nèi)部統(tǒng)計(jì)圖表,在自助統(tǒng)計(jì)圖表 可以自己生成每日調(diào)用總次數(shù)的柱狀圖或折線圖
第1步:在果創(chuàng)云上快速接入你的API接口
首先,進(jìn)入果創(chuàng)云,發(fā)布一個(gè)新接口。

選中【請(qǐng)求外部接口】,然后填寫你原來(lái)API接口的地址。

生成好的接口模板代碼如下,只有這個(gè)環(huán)節(jié),你需要低代碼接入和調(diào)整你的API接口。

完成后,發(fā)布你的API接口,接入到果創(chuàng)云。
其中,要注意以下代碼片段的使用,其目的是:當(dāng)子應(yīng)用請(qǐng)求接口并且返回正常時(shí),才會(huì)記錄調(diào)用明細(xì)。
// 記錄子應(yīng)用調(diào)用
if (defined('SUB_APP_KEY')) {
$api_bill_list = $di->db->api_bill_list;
$new_bill = array('sub_app_key' => SUB_APP_KEY, 'add_time' => date('Y-m-d H:i:s'));
// 參考開發(fā)文檔:www.yesapi.cn/docs/#/v2.0/function_lite?id=f1-3、數(shù)據(jù)庫(kù)-添加表單數(shù)據(jù)
$api_bill_list->insert($new_bill);
}
第2步:創(chuàng)建一張新表單:調(diào)用明細(xì)api_bill_list
繼續(xù)添加一張新表單,調(diào)用明細(xì)api_bill_list,并且添加字段:子應(yīng)用app_key。

添加好需要的表字段后,API調(diào)用明細(xì)表單結(jié)構(gòu)如下:

存放子應(yīng)用調(diào)用明細(xì)后,數(shù)據(jù)效果如下:

以上操作,都不需要代碼開發(fā),直接界面操作即可。
第3步:創(chuàng)建子應(yīng)用、分配接口總流量上限
進(jìn)入到客戶端管理,添加一個(gè)新客戶端應(yīng)用。

并且可以為你的子應(yīng)用分配接口總流量上限。

第4步:給你的開發(fā)者提供調(diào)用記錄賬單
接下來(lái),還可以給你的開發(fā)者提供調(diào)用的記錄賬單查詢列表。點(diǎn)擊:【數(shù)據(jù)分享】,

配置好搜索條件,讓開發(fā)者必須填寫自己的子應(yīng)用app_key,方可查詢調(diào)用賬單明細(xì)。

即在搜索設(shè)置:
sub_app_key|子應(yīng)用app_key|=|是
保存預(yù)覽后,可以看到以下效果:

第5步:內(nèi)部統(tǒng)計(jì)圖表,查看每日調(diào)用總次數(shù)的柱狀圖或折線圖

在【統(tǒng)計(jì)圖表】,創(chuàng)建一個(gè)新圖表,

繼續(xù)選擇剛才新建的 API調(diào)用明細(xì) 表單,

下一步,繼續(xù)定制統(tǒng)計(jì)報(bào)表的口徑和維度,

最后,生成圖表。

查看圖表,就可以看到每天接口總請(qǐng)求的柱狀圖,還有表格數(shù)據(jù),還可以對(duì)比上個(gè)月。目前因?yàn)槿鄙贉y(cè)試數(shù)據(jù),所以圖表沒(méi)有數(shù)據(jù)展現(xiàn)。

搞定!
