操作API介绍

应用开放平台更名为OpenAPI，迁移至开放服务云

API基本信息

API编码

手工录入，建议创建有实际业务语义的编码

API名称

手工录入，建议创建有实际业务语义的名称

请求方式

API请求方法，支持GET/POST

业务对象

操作服务的业务对象

所属应用

业务对象所属应用

操作方式

业务对象的操作，如查询、保存等

使用状态

API使用状态共有四种。

内测：接口仍在内部测试中；

发布：正式对外开放；

维护：API将来会被废弃，不推荐使用；

禁用：禁止使用。

适用版本号

依赖的实体对象对应的苍穹最低版本号

请求地址

请求url地址，自动生成格式为：/kapi/v2/{isv}/{appId}/{formId}/{serviceName}

{isv}：开发商标识，金蝶标准接口的开发商标识为空

{appid}：业务对象所属的应用编码

{formId}：业务对象编码
{serviceName}：输入的API编码

详细描述

API详细描述及功能场景用途

配置项

第三方应用授权

开关打开，代表该API不允许通过cookies、匿名等非第三方应用认证的方式访问

出参仅返回Data域

出参仅返回Data域（不包括Status）

返回动态对象

【仅查询操作展示】开启后返回DynamicObject 的序列化数据，可通过反序列将其还原为DynamicObject对象

【仅查询操作展示】启用后，会校验当前调用接口用户的组织权限和数据规则，避免查询到用户权限范围外的数据

请求头部

参数名称

请求头参数名称，系统已默认预置content_type和access_token，无需重复添加

参数值

请求头参数值

说明

请求头参数说明

Query参数

参数名称

Query参数名称，即请求的入参。即可以从业务对象中添加，也可以手工添加，允许修改参数名称。

对象属性

若从业务对象中添加，则为添加的实体属性编码；若是手工添加的参数，则和参数名称保持一致。不允许修改

参数类型

Query参数类型

必填

定义查询类API服务的Query参数，在调用时是否必传

说明

Query参数说明

层级

参数在业务对象中所在层级，如：若参数为分录中的参数，则层级为2

示例

Query参数示例，根据选择的参数自动带出

查询条件

左括号

当查询条件有多个时，可以添加括号组合查询，如查询条件为（A or B）and C

条件字段

只允许从业务对象中选择，条件字段用于和用户传入的Query参数进行比较，用来过滤查询指定的数据，如createtime（条件字段） 大于 time（query参数）、billstatus （条件字段） 等于 status（query参数）

字段类型

根据条件字段自动带出

字段描述

根据条件字段自动带出

比较方式

支持14种比较方式：等于、不等于、在...中、不在...中、为空、不为空、包含、不包含、以...开始、以...结束、大于、小于、大于等于、小于等于。

比较变量

与条件字段作比较变量名称，来源于query参数

右括号

当查询条件有多个时，可以添加括号组合查询，如查询条件为(A or B) and C

逻辑连接符

与/或，用于组合不同的查询条件

排序

排序字段

只允许从业务对象中选择，用于控制返回参数的排序，用法同order by。

字段描述

根据排序字段自动带出

排序方式

顺序/倒序

返回参数

参数名称

返回参数名称，组装在返回信息的data中，只能从业务对象中添加，允许修改参数名称

对象属性

添加的实体属性编码，不允许修改

参数类型

返回参数类型

说明

返回参数说明

层级

参数在业务对象中所在层级，如：若参数为分录中的参数，则层级为2

示例

返回参数示例，根据选择的参数自动带出

API基本信息

字段与get请求一致

请求头部

字段与get请求一致

请求体

参数名称

请求体参数名称，即请求的入参。即可以从业务对象中添加，也可以手工添加，允许修改参数名称

对象属性

若从业务对象中添加，则为添加的实体属性编码；若是手工添加的参数，则和参数名称保持一致。不允许修改。

参数类型

请求体参数类型

必填

定义请求体参数，在调用时是否必传

说明

请求体参数说明

层级

参数在业务对象中所在层级，如：若参数为分录中的参数，则层级为2

示例

请求体参数示例，根据选择的参数自动带出

查询条件

当操作方式为保存（save）时隐藏

左括号

当查询条件有多个时，可以添加括号组合查询，如查询条件为（A or B）and C

条件字段

只允许从业务对象中选择，条件字段用于和用户传入的请求体参数进行比较，用来过滤查询指定的数据，如createtime（条件字段） 大于 time（请求体参数）、billstatus （条件字段） 等于 status（请求体参数）

字段类型

根据条件字段自动带出

字段描述

根据条件字段自动带出

比较方式

支持14种比较方式：等于、不等于、在...中、不在...中、为空、不为空、包含、不包含、以...开始、以...结束、大于、小于、大于等于、小于等于。

比较变量

与条件字段作比较变量名称，来源于请求体参数

右括号

当查询条件有多个时，可以添加括号组合查询，如查询条件为(A or B) and C

逻辑连接符

与/或，用于组合不同的查询条件

排序

仅当操作方式为查询（query）时展示，字段与get请求一致

保存参数

仅当操作方式为保存（save）时展示

参数项

特殊保存功能参数

说明

参数说明

值

参数值

返回参数

参数名称

返回参数名称，即请求的出参

参数类型

返回参数类型

说明

返回参数说明

示例

返回参数示例

错误码

单据头

保存

保存当前API服务信息

API测试

打开API在线测试弹窗界面

退出

退出当前界面

请求头

增行

列表新增空白行

删行

点击按钮，删除勾选行数据，支持多条数据批量删除

上移

勾选请求头数据，点击按钮，行数据会上移一行

下移

勾选请求头数据，点击按钮，行数据会下移一行

参数示例

弹出请求参数示例弹窗

Query参数/请求体

添加属性

弹出对象选择弹窗，支持批量勾选，点击确定后会自动填充数据到query参数/请求体列表中

参数示例

弹出请求参数示例弹窗

增行

列表新增空白行

删行

点击按钮，删除勾选行数据，支持多条数据批量删除

上移

勾选行数据，点击按钮，行数据会上移一行

下移

勾选行数据，点击按钮，行数据会下移一行

查询条件

增行

列表新增空白行

删行

点击按钮，删除勾选行数据，支持多条数据批量删除

插入

点击按钮，插入空白行

预览

点击按钮，弹出查询API