接口开放平台
出于下游客户和开发者需要调用API和进行数据自动化对接的需求,当企业需要对外开放API接口时,就需要搭建自己的接口开放平台,并向外部开发者提供OpenAPI。
产品设计脑图
结合前面分享的文章:自建API接口管理平台的产品脑图和解决方案,本次继续分享在接口开放平台的产品设计脑图及其解决方案。
API开放平台脑图如下(点击图片可以查看高清原图):
API开放平台的设计脑图
按产品优先级划分,API开放平台所需要具备的功能模块主要有:
核心领域的:登录注册、应用管理、接口权限、接口文档
支持领域的:服务大厅、流量统计、首页
通用领域的:个人中心、工单管理
开放平台的使用说明
从外部开发者的角度,当开发者需要使用开放平台时,一般需要经历以下三个阶段。
第一阶段,引导开发者自助注册,开通账号。
第二阶段,引导开发者创建应用,申请接口权限。
第三阶段,开发者根据API接口规范,查看、接入和调用所需要的API接口。
可以在开放平台的首页给予新人引导,例如:
另外,在开发文档时,再配套提供更简洁的接入流程说明。例如下图:
登录注册
对于开放平台,开发者可以选择自行注册和登录。
注册时,可以选择不同的开发者角色,以便后续进行按角色分配接口权限,方便管理。
创建应用
开发者成功注册后,需要先申请和创建他的应用。开发者应用是指调用API接口的程序、系统和终端。成功创建和申请应用后,将会得到app_key和密钥。
查看接口文档和调用API
在登录的情况下,进入开放平台后,开发者可以查看自己每个应用所开通的API接口权限。
也可以在未登录的情况下,以游客的身份查看开放接口的在线接口文档,提前了解开放平台具备、提供和开放了哪些API接口服务能力。
在具体的API接口文档,开发者可以查看每个API接口的名称、功能描述、接口路径、接口参数和返回等信息。
购买付费API
如果某些API接口需要付费开通后才能使用,开发者需要能先查看每个接口的服务套餐,进行在线下单,和查看成功购买后的接口服务包,以及流量消耗情况。最好能在余额不足时及时提醒开发者。
接口流量统计和账单
最后,再配套为开发者提供接口调用的账单统计。