我们的iPaaS API公开市场是一个API服务共享平台。作为平台服务的重要组成部分,我们的iPaaS为企业用户提供API分享、授权、调试等服务。企业用户可将iPaaS平台内的API资产发布至API公开市场中,实现企业内API资源共享,并满足上下游合作伙伴的接口需求。
下面我们将结合场景实例,为大家介绍API上架公开市场与调用授权的使用技巧。
场景一:API上架公开市场
大型企业内部组织结构相对复杂,多系统林立,且互不了解各个部门或系统的API资产。因此针对同一系统的数据利用,存在重复开发的问题。
且公司部分数据需要提供给上下游服务商或供应商,传统的数据导入导出或接口对接,沟通成本高,且效率低下。
针对这一场景,得帆云iPaaS平台提供了API公开市场。企业内用户可将自己的API资产上架至公开市场,供其他人员/企业测试、调用,轻松实现企业之间与企业内部数据的互流互通,打破企业数据孤岛。
API上架公开市场的配置方式如下:
首先,租户登录系统,在API开发列表中,点击操作列中的「申请上架」按钮,提交API上架公开市场的申请。
租户系统-API开发-申请上架
之后,市场管理登录API公开市场管理后台,在「待办中心」内,对租户内提交API上架申请进进行审核。
市场管理后台-待办中心
审批完成之后,API将会出现在「上架管理」列表中,市场管理员可对「上架管理」中的API进行发布上架、下架、编辑API可见权限以及API基础信息和文档的维护。
市场管理后台-上架管理
发布完成后,用户可以在API市场前台查询已发布的API,点击可查看API详情并测试调用(测试调用需要用户提前完成注册并登录)。
用户访问公开市场
场景二:市场内API独立的网关控制
因为API使用者的用户角色多且复杂,每个角色需要的访问权限不同,如果不对每个API的频次等网关加以控制,API的访问频率会大大提高,加重服务器的运行负担。
针对这一场景,得帆云iPaaS API公开市场提供了网关插件,市场管理员可以设置某一API访问权限和请求频次、大小等控制。
API公开市场支持配置IP黑白名称、请求频次、请求体大小等网关;支持根据测试调用,授权用户等场景进行设置;支持针对授权用户单独设置网关权限。
API公开市场网关插件的配置方式如下:
在「公开市场」——「上架管理」中,市场管理员点击某一API后,在API详情抽屉中,打开「网关插件」,通过打开右侧开关,配置当前API上架至API市场后,关联的网关控制。
API详情-网关插件
打开IP控制时,选择应用场景或指定用户,输入IP地址的黑、白名单,以及响应Code和响应Message。
-
IP白名单:在IP白名单中的IP地址用户,可以正常访问该API;
-
IP黑名单:在IP黑名单中的IP地址用户,无法访问该API;
网关控制-IP控制
打开「请求频次控制」时,选择应用场景或指定用户,输入频次限制,以及响应Code和响应Message,可控制用户调用当前API的频次限制。
网关控制-请求频次控制
打开「请求体大小控制」,选择应用场景或指定用户,输入请求体大小的限制,以及响应的Code和响应Message,可控制用户调用当前API的请求体大小。
网关控制-请求体大小控制
场景三:市场用户测试调用&申请授权
在API公开市场中,登录用户可在线测试接口,并且按照测试调用场景配置的网关服务进行调用。如果需要特殊的调用频次或请求体大小,可提交申请,申请API授权,并由市场管理员审批授权。
市场用户测试调用&申请授权的配置方式如下:
在API详情页中,登录用户可点击「测试API」按钮进行API在线测试。
API详情页-API测试调用
在API详情页中,登录用户可点击「申请授权」按钮申请API权限。
点击后,弹出「创建申请」弹窗,用户填入申请授权有效期截止时间和申请理由,点击确定后会将该条申请信息发送至系统管理员进行审批。创建申请后,申请授权按钮会变为“申请中”。
API详情页-API申请授权
市场管理员在市场管理后台待办列表中,可查看API授权的申请信息,并进行审批;
市场管理后台-待办中心
授权通过后,用户可在「个人中心」——「授权信息」中查看自己授权的API信息。
个人中心-授权信息
以上就是我们的iPaaS API公开市场中「API上架公开市场」、「市场内API独立的网关控制」和「市场用户测试调用&申请授权」的配置方法。学会这些,你就可以更安全高效地玩转iPaaS API公开市场啦!
以上就是本期的使用技巧分享,我们下期再见~