果创云:如何开放自己的API接口给他人调用并限制请求次数?

广州果创网络科技有限公司

共 1580字,需浏览 4分钟

 ·

2023-08-11 01:40

你将学到什么?

可以帮助你实现:将自己的API接入到果创云,然后创建子应用给到你的客户或你的开发者进行接口调用,并统计调用次数。平台暂时不支持线上结算,需要自己进行线下接口调用次数的内部结算。

预计需要开发时间:0.5天,其他步骤都可以通过界面可视化操作完成。

主要使用步骤:

  • 1. 在果创云上快速接入你的API接口,生成并创建一个请求外部接口

  • 2. 创建一张新表单:调用明细api_bill_list,添加字段:子应用app_key

  • 3. 在 客户端管理,添加一个新的子应用,并把子应用app_key提供给你的开发者。可以针对每个子应用设置接口总流量上限。

  • 4. 如果还需要给你的开发者提供调用记录账单,可以使用 表单数据分享,为每一个开发者单独创建一个分享链接

  • 5. 内部统计图表,在自助统计图表 可以自己生成每日调用总次数的柱状图或折线图

第1步:在果创云上快速接入你的API接口

首先,进入果创云,发布一个新接口。


选中【请求外部接口】,然后填写你原来API接口的地址。


生成好的接口模板代码如下,只有这个环节,你需要低代码接入和调整你的API接口。


完成后,发布你的API接口,接入到果创云。

其中,要注意以下代码片段的使用,其目的是:当子应用请求接口并且返回正常时,才会记录调用明细。

			// 记录子应用调用
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'));
// 参考开发文档:www.yesapi.cn/docs/#/v2.0/function_lite?id=f1-3、数据库-添加表单数据
$api_bill_list->insert($new_bill);
}

第2步:创建一张新表单:调用明细api_bill_list

继续添加一张新表单,调用明细api_bill_list,并且添加字段:子应用app_key。


添加好需要的表字段后,API调用明细表单结构如下:


存放子应用调用明细后,数据效果如下:


以上操作,都不需要代码开发,直接界面操作即可。

第3步:创建子应用、分配接口总流量上限

进入到客户端管理,添加一个新客户端应用。


并且可以为你的子应用分配接口总流量上限。


第4步:给你的开发者提供调用记录账单

接下来,还可以给你的开发者提供调用的记录账单查询列表。点击:【数据分享】,


配置好搜索条件,让开发者必须填写自己的子应用app_key,方可查询调用账单明细。


即在搜索设置:

sub_app_key|子应用app_key|=|是

保存预览后,可以看到以下效果:


第5步:内部统计图表,查看每日调用总次数的柱状图或折线图



在【统计图表】,创建一个新图表,


继续选择刚才新建的 API调用明细 表单,


下一步,继续定制统计报表的口径和维度,


最后,生成图表。


查看图表,就可以看到每天接口总请求的柱状图,还有表格数据,还可以对比上个月。目前因为缺少测试数据,所以图表没有数据展现。


搞定!


浏览 55
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报
评论
图片
表情
推荐
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报