接口开放平台的产品设计脑图及解决方案

简介: 接口开放平台的产品设计脑图及解决方案

接口开放平台

出于下游客户和开发者需要调用API和进行数据自动化对接的需求,当企业需要对外开放API接口时,就需要搭建自己的接口开放平台,并向外部开发者提供OpenAPI。

产品设计脑图

结合前面分享的文章:自建API接口管理平台的产品解决方案,本次继续分享在接口开放平台的产品设计脑图及其解决方案。

API开放平台脑图如下(点击图片可以查看高清原图):

API开放平台的设计脑图

按产品优先级划分,API开放平台所需要具备的功能模块主要有:

核心领域的:登录注册、应用管理、接口权限、接口文档

支持领域的:服务大厅、流量统计、首页

通用领域的:个人中心、工单管理

开放平台的使用说明

从外部开发者的角度,当开发者需要使用开放平台时,一般需要经历以下三个阶段。

第一阶段,引导开发者自助注册,开通账号。

第二阶段,引导开发者创建应用,申请接口权限。

第三阶段,开发者根据API接口规范,查看、接入和调用所需要的API接口。

可以在开放平台的首页给予新人引导,例如:

另外,在开发文档时,再配套提供更简洁的接入流程说明。例如下图:

登录注册

对于开放平台,开发者可以选择自行注册和登录。

注册时,可以选择不同的开发者角色,以便后续进行按角色分配接口权限,方便管理。

创建应用

开发者成功注册后,需要先申请和创建他的应用。开发者应用是指调用API接口的程序、系统和终端。成功创建和申请应用后,将会得到app_key和密钥。

查看接口文档和调用API

在登录的情况下,进入开放平台后,开发者可以查看自己每个应用所开通的API接口权限。

也可以在未登录的情况下,以游客的身份查看开放接口的在线接口文档,提前了解开放平台具备、提供和开放了哪些API接口服务能力。

在具体的API接口文档,开发者可以查看每个API接口的名称、功能描述、接口路径、接口参数和返回等信息。

购买付费API

如果某些API接口需要付费开通后才能使用,开发者需要能先查看每个接口的服务套餐,进行在线下单,和查看成功购买后的接口服务包,以及流量消耗情况。最好能在余额不足时及时提醒开发者。

接口流量统计和账单

最后,再配套为开发者提供接口调用的账单统计。

相关文章
|
缓存 NoSQL API
GraphQL(三)DataLoader 详解
本文为GraphQL DataLoader详解,主要包括批处理及缓存的相关内容。DataLoader是一个通用实用程序,用作应用程序数据获取层的一部分,通过和为各种远程数据源(如数据库或 Web 服务)提供简化且一致的 API
|
运维 IDE Java
SOA(面向服务架构)是什么?
SOA(面向服务架构)是什么?
3648 0
SOA(面向服务架构)是什么?
|
存储 运维 监控
API明细日志及运维统计日志全面提升API可运维性
在数字化转型的大潮中,数据已成为企业最宝贵的资产之一。而数据服务API可快速为数据应用提供数据接口。面对越来越多的API以及越来越多的应用调用,如何快速查看API的服务情况、异常情况及影响范围,以及查看API的调用详情,进行API的性能优化、错误排查变得越来越重要,本文将介绍如何配置和开通API运维统计及明细日志,以及如何查看日志进行介绍。
703 0
|
数据可视化 搜索推荐 小程序
LowCode:低代码平台,2024国内十大主流低代码平台年终盘点
低代码平台是一种加速软件开发的高效工具,通过可视化和模型驱动的方式减少手动编码,快速构建应用。它能显著提升开发效率,降低开发成本,支持企业快速实现数字化转型。国内主流低代码平台如织信Informat、白码、钉钉宜搭等,各具特色,可根据企业需求选择合适的平台。私有化部署更是确保数据安全和定制化的重要手段。
|
Java 测试技术 数据库连接
使用Spring Boot编写测试用例:实践与最佳实践
使用Spring Boot编写测试用例:实践与最佳实践
1585 0
|
BI API 数据安全/隐私保护
自建API接口管理平台的产品脑图和解决方案
自建API接口管理平台的产品脑图和解决方案
|
消息中间件 测试技术 领域建模
DDD - 一文读懂DDD领域驱动设计
DDD - 一文读懂DDD领域驱动设计
48160 6
|
Ubuntu Java Linux
Ubuntu20.04下载jdk遇到各种奇怪问题大集,Linux如何将默认的OpenJDK切换成自己安装的JDK版本(以JDK1.8为例),无需卸载原有OpenJDK,Some packages co
Ubuntu20.04下载jdk遇到各种奇怪问题大集,Linux如何将默认的OpenJDK切换成自己安装的JDK版本(以JDK1.8为例),无需卸载原有OpenJDK,Some packages co
|
算法 JavaScript
算法(分治、贪心、dp、回溯、分支限界)总结
算法(分治、贪心、dp、回溯、分支限界)总结
283 0