苍穹OpenAPI新体验 之 查询接口
金蝶云苍穹Open API是金蝶自研的企业级API接口服务引擎，基于OpenAPI提供丰富的符合Restful规范的API接口，全面覆盖各领域开放接口的使用场景，帮助企业快速接入外部第三方应用，连接用户、员工和上下游伙伴。
本期，小编先为大家讲解常用的查询接口功能及其实现方式~
1 API2.0新引擎简介
开放平台新版本API2.0引擎，优化了接口路由，由ISV标识、应用、业务对象、API编码组合生成，支持对单个对象建立多种场景化API服务。
新引擎重新定义了操作服务的出入参结构、接口的请求参数和返回参数，严格遵循页面配置，用户在界面通过简单的配置即可一键测试并发布API接口，同时自动生成标准的API文档。
2 API查询服务功能简介
开放平台支持配置各应用的场景化API查询服务，由苍穹API开发人员配置查询条件，提供语义化的查询条件参数，更便于调用方使用。定义API时，支持配置API返回属性、参数及数据过滤条件，避免泄露敏感属性，提升了API的数据安全性。
3 查询接口功能实现
以企业采购业务中常见的采购订单为例，下面介绍如何在开放平台发布一个采购订单的查询接口。
步骤一：录入API基本信息
输入API编码、API名称、业务对象、操作方式、详细描述等信息，请求方式为“GET”，自动生成API请求地址。
录入API基本信息示例
步骤二：定义请求头部
系统已预置了content_type(内容类型）和accesstoken（请求令牌）两个参数，无需再人工维护。
定义请求头部示例
步骤三：定义请求参数
即请求入参，支持手工添加或点击“添加属性”按钮快速添加参数。请求入参必须按界面配置传参，并有必填性校验。
定义请求体参数示例
步骤四：定义查询条件
在界面配置接口的可视化处理逻辑，点击“查询条件”，选择条件字段并和Query参数进行比较，生成查询条件。同时支持按常量查询，如固定查询某个组织下的数据，对敏感数据进行隔离。
注：当查询条件可选择的比较方式有“在...中”或“不在...中”时，若对应的比较变量较多，则参数类型可以选择Array数组类型，如Array<Integer>、Array<String>、Array<Long>、Array<Date>。
定义查询条件示例
步骤五：定义排序（可选）
选择接口返回数据的排序依据，支持按业务对象中的字段进行排序，可定义顺序或倒序，同时支持组合排序。
定义返回数据的排序示例
步骤六：定义返回参数及错误码
维护接口需要返回的参数和接口错误码，确认后点击“保存”按钮，完成接口注册。
定义返回参数及错误码示例
步骤七：在线调试API
在界面上点击“API测试”按钮，打开在线测试弹窗界面。系统获取API维护页面传递的请求地址，并自动拼接成访问URL。
点击“Send”按钮，后台模拟调用HTTP的GET请求访问服务，并将返回参数展示在页面的Response中。
API调试示例
4 亮点价值
OpenAPI2.0查询接口可通过简单的界面配置自定义出入参，让接口更贴合实际业务场景，且无需代码开发，一键发布；
用户只需在界面维护示例数据，即可自动生成对应请求参数示例及标准API文档；
通过API测试功能可以在线调试接口而不需要依赖第三方测试工具，极大降低了用户的使用门槛，提升了系统对接效率。
5 更多资讯
6 划重点
1. 开放平台支持配置各应用的场景化API查询服务，可通过简单的界面配置自定义查询接口的出入参，且无需代码开发，一键发布。
2. 以发布一个常见的采购订单的查询接口为例，实现步骤如下：
步骤一：录入API基本信息；
步骤二：定义请求头部；
步骤三：定义请求体参数；
步骤四：定义查询条件；
步骤五：定义接口返回数据的排序依据（可选）；
步骤六：定义返回参数及错误码；
步骤七：在线调试API。
#往期推荐#
更多精彩内容，“码”上了解！↓
苍穹OpenAPI新体验 之 查询接口
本文2024-09-23 00:27:28发表“云苍穹知识”栏目。
本文链接：https://wenku.my7c.com/article/kingdee-cangqiong-139582.html
