自定义API（Java插件）

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

自定义API（Java插件）

变更记录

产品版本	更新内容	更新日期
V5.0.011	初始版本	2022年6月
V6.0.1	应用开放平台更名为OpenAPI，迁移至开放服务云	2023年9月

1. 简介

1.1 功能介绍

自定义API主要通过Java插件来解决复杂的API集成场景，如调用微服务或对文件流、图像等进行处理。用户预先定义类和方法，通过简单配置，快速生成自定义API。

备注：自定义API案例见附件

1.2 应用场景

发布API接口供第三方应用调用，帮助用户快速完成苍穹平台与异构系统间的数据集成。

1.3 系统路径

【开放服务云】→【OpenAPI】→【API管理】→【API开发】

1.4 字段说明

字段名称	详细解释
API基本信息
所属应用	所属应用
API编码	不允许编辑，根据自定义类的方法名生成
API名称	手工录入，建议创建有实际业务语义的名称
请求方式	API请求方法，自动生成
自定义分类	手工录入，自定义API的所属分类
所属应用	API所属应用
API状态	API使用状态共有四种：内测：接口仍在内部测试中；发布：正式对外开放；维护：将要废弃，不推荐使用；禁用：禁止使用。
类名	自定义类名
方法名	自定义方法名
请求地址	请求url地址，自动生成格式为：/kapi/v2/{isv}/{appId}/{serviceName} {isv}：开发商标识，金蝶标准接口的开发商标识为空 {appid}：业务对象所属的应用编码 {serviceName}：类中定义好的API编码
详细描述	API详细描述及功能场景用途
配置项
第三方应用授权	开关打开，代表该API不允许通过cookies、匿名等非第三方应用认证的方式访问。
匿名访问	开关打开，接口允许匿名访问
出参仅返回Data域	出参仅返回Data域（不包括Status）
防止重复请求	开关打开后，相同请求参数的请求在30秒内只能调用一次
WebSevice信息
命名空间	Webservice接口的命名空间，建议以http或https开头
输入参数名	输入参数名
输出参数名	输出参数名
WSDL方法名称	WSDL方法名称
请求头部
参数名称	请求头参数名称，系统已默认预置content_type和access_token，无需重复添加
参数值	请求头参数值
说明	请求头参数说明
请求体
参数名称	参数名称
参数类型	参数类型
多值	是否多值
必填	是否必填
说明	参数说明
层级	参数在业务对象中所在层级，如：若参数为分录中的参数，则层级为2
示例	参数示例
返回参数
参数名称	返回参数名称
参数类型	返回参数类型
多值	是否多值
说明	参数说明
层级	参数在业务对象中所在层级
示例	参数示例
错误码
错误码	API接口错误码
描述	错误码描述

1.5 按钮说明

按钮名称	详细解释
单据头
保存	保存当前API服务信息
重载方法信息	当自定义类及方法修改后，需要点击同步按钮，同步最新的请求参数
API测试	打开API在线测试弹窗界面
退出	退出当前界面
请求头
增行	列表新增空白行
删行	点击按钮，删除勾选行数据，支持多条数据批量删除
上移	勾选请求头数据，点击按钮，行数据会上移一行
下移	勾选请求头数据，点击按钮，行数据会下移一行
参数示例	弹出请求参数示例弹窗
请求体
参数示例	弹出请求参数示例弹窗
返回参数
参数示例	弹出返回参数示例弹窗
错误码
增行	列表新增空白行
删行	点击按钮，删除勾选行数据，支持多条数据批量删除