自定义API（脚本开发）
变更记录
产品版本 | 更新内容 | 更新日期 |
| V5.0.011 | 初始版本 | 2022年6月 |
| V6.0.1 | 应用开放平台更名为OpenAPI，迁移至开放服务云 | 2023年9月 |
1. 简介
1.1 功能介绍
通过脚本开发的API，可实现多个API、微服务之间的组合调用，开发便捷，部署灵活。
备注：接口开发案例见附件
1.2 应用场景
使用脚本开发API，供外部第三方应用调用，解决复杂的API集成场景。
1.3 系统路径
【开放服务云】→【OpenAPI】→【API管理】→【API开发】
1.4 字段说明
字段名称 | 详细解释 |
API基本信息 | |
所属应用 | 所属应用 |
API编码 | API编码 |
API名称 | 手工录入，建议创建有实际业务语义的名称 |
请求方式 | API请求方法，GET/POST |
自定义分类 | 手工录入，自定义API的所属分类 |
所属应用 | 业务对象所属应用 |
| API状态 | API使用状态共有四种：
|
| 请求地址 | 请求url地址，自动生成格式为：/kapi/v2/{isv}/{appId}/{serviceName}
|
| 详细描述 | API详细描述及功能场景用途 |
| 配置项 | |
| 第三方应用授权 | 开关打开，代表该API不允许通过cookies、匿名等非第三方应用认证的方式访问 |
| 出参仅返回Data域 | 出参仅返回Data域（不包括Status） |
| 防止重复请求 | 开启防止重复请求时，相同请求参数的请求在30秒内只能调用一次 |
WebSevice信息 | |
命名空间 | Webservice接口的命名空间，建议以http或https开头 |
输入参数名 | 输入参数名 |
输出参数名 | 输出参数名 |
| WSDL方法名称 | WSDL方法名称 |
请求头部 | |
参数名称 | 请求头参数名称，系统已默认预置content_type和access_token，无需重复添加。 |
参数值 | 请求头参数值 |
说明 | 请求头参数说明 |
请求体 | |
参数名称 | 参数名称 |
参数类型 | 参数类型 |
多值 | 是否多值 |
| 必填 | 是否必填 |
说明 | 参数说明 |
层级 | 参数在业务对象中所在层级，如：若参数为分录中的参数，则层级为2 |
示例 | 参数示例 |
| API脚本 | 脚本编辑内容区 |
返回参数 | |
参数名称 | 返回参数名称 |
参数类型 | 返回参数类型 |
多值 | 是否多值 |
说明 | 参数说明 |
层级 | 参数在业务对象中所在层级 |
示例 | 参数示例 |
| 引用资源 | |
| 资源类别 | 引用资源类别，默认为API服务维护 |
| 引用类别 | 即API接口 |
| 别名 | 资源别名 |
| 错误码 | |
| 错误码 | API接口错误码 |
| 描述 | 错误码描述 |
1.5 按钮说明
按钮名称 | 详细解释 |
单据头 | |
保存 | 保存当前AP |
自定义API（脚本开发）
声明：除非特别标注，否则均为本站原创文章，转载时请以链接形式注明文章出处。如若本站内容侵犯了原著者的合法权益，可联系本站删除。
