API接口管理平台
如果需要自建API接口管理平台,首先要定位和明确需要给谁(开发者是谁)、以什么方式(免费/付费)、提供什么接口(内部接口,数据接口还是上游供应商的API接口)。
站在产品经理的角度,规划一个API接口管理平台,需要有业务、技术、市场的功底,才能打造一个闭环的接口服务方案。
按需求优先级,API接口管理平台的功能可以分为四大类:核心类功能、辅助类功能、支撑类功能、基础类功能。
核心类功能:接口管理、接口计费。
辅助类功能:开发者管理、应用管理。
支撑类功能:工单管理、计划任务、上传文件管理、配置管理。
基础类功能:数据库管理、统计报表、后台权限控制、登录、首页。
产品脑图
为了方便大家整体规划和了解API接口管理平台需要哪些功能,可以参考以下API接口管理平台的脑图(点击图片可以查看高清原图)。
下面以部分的功能模块,介绍实现的效果和作用。
后台登录
管理后台的基本登录。
接口管理
首先,需要用到的是接口开发。有了API接口,才能进行调用、开放和使用。
在接口开发列表,可以管理和查看API接口,并对其进行管理、发布、编辑和开发、调试。
在单个API接口开发时,你可以对接口名称、接口描述、接口路径、接口标题、接口请求方式(GET/POST)、接口版本号、接口源代码、接口参数、接口返回字段、接口示例、接口错误码等进行维护和在线编辑。
编辑接口后,还可以进行在线接口测试、在线接口调试、发布接口、管理接口权限、查看接口在线文档等一序列操作。
API接口发布后的在线接口文档。可以分多个项目、分空间、分目录模块进行接口分类管理。
以及自动生成的在线API接口文档,支持实时生成、离线导出、在线接口测试、国际化翻译等。
有了API接口后,可以对接口进行权限分配。例如,分配开放给指定的开发者角色,或指定的开发者账号,或指定应用。
如果需要限制客户的调用,还可以设置IP白名单、每天接口次数限制、应用审核、有效日期、接口签名、接口参数加密等。
接口计费
对于开放的API接口,除了可以分配接口权限,限制调用次数和IP白名单等外,如果需要进行接口流量计费,就城用到套餐、订单、已购买服务、工单服务等配套的功能支持。
首先,在管理后台,可以添加套餐,并对套餐进行管理,设定价格等。
在添加接口服务套餐时,可以分为:免费试用、付费套餐和组合套餐。
支付方式,可以配置现金支付(人工充值)、支付宝在线支付、Paypay(国际付款)。
当开发者下单购买后,即可以查看到对应的订单,并对订单进行统计和管理,以及查看已经发放的接口服务包和消耗情况。当接口流量快消耗完时或快到期时,可以提醒开发者及时续约和续费。
开发者管理
开发者管理是对开发者的账号密码进行管理,并对开发者的身份进行核实和认证。
应用管理
由于最终调用API接口的是程序、是系统、是客户端,而不是人、不是开发者,所以我们需要进行应用管理。对于创建的应用,需要在审核通过后才可以调用API接口,避免API非法调用和访问。
创建应用时,有几个关键的信息:应用名称、app_key和密钥,是最基本的应用信息。此外还可以有一些权限设置。
统计报表
首页统计,包括了常用的数据汇总和报表。关心的核心数据指标是:待审核应用数量(拉新)、接口实时流量统计(API调用量)、订单数量(平台盈利能力)、API总数(接口品类和服务能力)。
API接口的实时统计流量,
每日接口统计,可以分析热门接口和每天的调用分布。
应用历史统计,查看客户端使用的情况,分析找出重点需要服务的客户对象,以及客户价值。
后台权限控制
如果需要多人同时管理API接口平台,可以对不同的管理员角色分配需要的后台菜单权限。
本篇文章,结合接口大师的经验,仅介绍了API接口管理平台的产品解决方案。为了自建API平台,还需要开放平台和其他子系统,后续继续分享,欢迎关注我。