OpenAPI整体介绍

栏目：云苍穹知识作者：金蝶来源：金蝶云社区发布：2024-09-23浏览：1

OpenAPI整体介绍

1 产品概述

1.1 产品介绍

苍穹平台的OpenAPI致力于提供符合Restful规范的接口，将企业数据及业务能力API化，全面覆盖各领域开放接口的使用场景，用户可以简单、安全、低成本地实现内外部系统集成和业务能力的开放。

概念介绍：

API：应用程序接口，是预先定义的函数，为程序之间数据交互和功能触发提供服务，调用者只需调用API，并输入预先约定的参数，即可实现开发者封装好的各种功能，无需访问功能源码或理解功能的具体实现机制。
API组成元素：API主要由请求地址（URL）、请求类型、请求头（header）和请求体（body）组成。
API主要用途：实现资源复用，避免重复“造轮子”；帮助开发人员，提高集成效率；解耦各系统，快速扩展功能。

1.2 产品结构图

苍穹OpenAPI主要功能包含API引擎、API安全、API服务、统计监控、在线测试等内容。通过金蝶云苍穹平台的技术能力，支持无代码、低代码、高代码快速API，将企业的业务能力对外开放，极大提升开发和集成效率。

1.3 业务场景

管理外部第三方应用接口调用权限：注册后的第三方应用能作为外部系统调用苍穹接口的身份标识，拥有登录认证、接口调用等功能，外部系统可通过第三方应用获取登录令牌或直接通过自动生成的密钥（基本认证）开始调用OpenAPI。
用户需要工具快速开发API：支持通过零代码配置、Java插件、脚本开发的模式发布API接口，接口的请求方式支持GET、POST。
帮助客户快速对接异构系统：接口同时发布为Rest API和WebService，可对接不同类型的新老系统，入参类型支持：

application/json
application/xml
text/xml
application/soap+xml
multipart/form-data
x-www-form-urlencoded

4. 帮助用户实时监控API调用情况：提供API日志和统计监控的功能，实时监控目标偏移情况。

2 业务流程

OpenAPI调用主流程主要分为以下四个步骤：

注册第三方应用
发布API服务
获取请求令牌
调用API服务

详情请参考OpenAPI调用流程。

3 亮点特性

3.1 零代码配置发布API

OpenAPI基于元数据驱动，可通过零代码配置的模式开发API，如查询、保存、提交等操作API均可快速开发并自动构建请求参数，让API发布和测试更便捷。

3.2 自定义API处理复杂场景

自定义API使用Java代码插件解决复杂的业务场景，如调用微服务或对文件流、图像等进行处理。同时支持使用脚本开发自定义API，不需要部署插件便可实现多个API、微服务、函数库等之间的组合调用，开发便捷，部署灵活。

3.3 多维度权限管控

操作API默认校验代理用户的组织和功能权限（自定义API在插件中自行处理权限校验）；
基于第三方应用进行接口权限控制，调用方只允许调用API授权清单范围内的接口；
支持配置IP黑白名单，只允许白名单内的IP段访问API，拒绝黑名单内的IP段访问API，提升系统安全性。

3.4 接口认证方式安全可靠

OpenAPI同时支持AccessToken认证、摘要认证、JWT认证、基本认证和签名认证共5种认证方式，用户可以根据实际需要选择不同的认证方式或扩展认证方式，满足企业安全方面的个性化需求。

3.5 API在线测试

模拟真实数据调用API服务，无需配置Postman，即可完成一键调试。

4 功能清单

序号	一级菜单	二级菜单	页面	功能说明
1	API管理	/	API服务维护	界面为左树右表结构，按按云、业务应用、业务对象（自定义分类）三个维度分类；用户可以新增API服务，维护API的基本信息、Webservice信息、请求参数和响应参数、错误码等信息。
2	API管理	/	API在线测试	API在线测试可模拟真实数据调用API服务，用户无需填写参数和url，自动获取token令牌，快速进行API测试，方便快捷。
3	API文档	/	API服务清单	API文档按云、业务应用、业务对象（自定义分类）三个维度分类，展示API基本信息、请求参数、请求结构示例、返回参数和返回结构示例、错误码等信息；支持获取匿名链接，发送给外部人员，无需登录系统即可查看API文档。
4	第三方应用	/	第三方应用维护	用于注册第三方应用，维护系统编码（appId)、系统密码(appSecret)、支持多种认证方式、API授权、访问策略等功能。
5	API日志	/	API调用日志	记录OpenAPI调用日志，包括接口出入参，API处理时间，调用者IP及账号等信息，用于日志审计及故障分析。
6	API统计	统计信息	API统计信息	API调用统计信息，按天、第三方应用、API三个维度展示具体的调用情况。
7	API统计	统计看板	API统计看板	API统计看板支持让用户实时监控目标偏离情况。
8	限流策略	/	限流策略	支持管理API限流策略，用户可维护策略描述、限流策略控制维度（API、第三方应用、匿名）、次数、流控效果等信息。
9	第三方API	连接配置	连接器配置	用于配置第三方系统的连接信息，支持多种连接类型。例如：京东、钉钉、法大大等。苍穹平台可通过该连接配置获取第三方系统的鉴权信息，并进行API的调用和会话刷新等操作。
10	第三方API	第三方API	自定义API	把外部系统的API注册到开放平台中，以便苍穹平台内部应用通过微服务调用该API。
11	其他	代码片段管理	代码片段管理	用于维护自定义API中引用的代码片段。
12			脚本调试	提供了帮助开发人员调试脚本的工具。
13			帮助手册	对脚本和微服务帮助内容进行了整理，方便用户学习和使用。
14		基础资料	自定义分类维护	维护自定义API的所属分类。
15		演示单据	开放平台单据示例	该示例单据可用于调试以及演示API接口。
16		API1.0	API服务	历史版本接口引擎的API服务列表，包含操作服务、自定义服务和AI服务，界面为左树右表结构，按业务应用分类。
17		API1.0	服务清单	历史版本接口引擎的API文档列表，左树结构，按业务应用分类，左树只展示有API服务的应用。服务清单提供了API的基本信息、请求参数、请求结构示例、返回参数和返回结构示例等信息。