1993-2022金蝶国际软件集团有限公司④内部公开请勿外传开放平台—零代码快速配置操作API金蝶云·苍穹开放平台服务部刘毅2022.12.142④内部公开请勿外传02概览1-1使用场景及特点2-1查询API|2-2保存API|2-3删除API|2-4空操作API03P03P05P11功能演示总结目录01013概览1-1使用场景及特点④内部公开请勿外传4使用场景及特点使用特点：•零代码无需开发，业务人员即可快速配置；•覆盖常见单据和基础资料的增删改查等接口集成场景，大幅降低系统集成交付成本。操作API是将金蝶云苍穹业务对象如单据、基础资料的操作（查询，保存，提交等），通过零代码配置的模式，一键发布成为OpenAPI，系统自动生成服务接口及服务契约。025功能演示2-1查询API2-2保存API2-3删除API2-4空操作API④内部公开请勿外传6查询API-示例：根据采购组织、时间范围查询采购订单查询操作API通过在界面配置请求参数、查询条件及返回参数来定义查询接口具体的功能。①配置项：打开“启用查询权限控制”开关（校验代理用户的组织权限和数据权限，防止越权）②请求参数：组织编码或名称、开始日期、结束日期③查询条件：采购组织编码=“组织编码”And“开始日期”<订单日期<“结束日期”④返回参数：根据实际接口需求，返回对接方需要的单据字段（敏感字段谨慎配置）查询接口示例：https://vip.kingdee.com/article/264032313930335232④内部公开请勿外传7保存API-示例：保存并自动提交采购申请单保存操作API通过在界面配置请求参数、操作参数、返回参数来定义保存接口具体的功能。①配置项：可选配置最大分录限制②请求参数：选择保存单据需要的字段，通过添加属性可快速增加增加。注意：必须维护候选键，单据头选择id或billno作为候选键（接口更新数据时的主键），分录一般选择分录id作为候选键③操作参数：选择默认参数forcedSumbit=sumbit④返回参数：平台标准返回格式，无法自定义保存接口示例：https://vip.kingdee.com/article/264036069879040768④内部公开请勿外传8删除API-示例：批量删除暂存状态供应商删除操作API与是通过在界面配置请求参数、查询条件来定义删除接口具体的功能。可按条件批量删除，定义接口时一定要谨慎定义查询条件，并充分测试，避免数据被误删。①请求参数：状态、供应商编码。②查询条件：供应商状态=“状态”And供应商编码in[供应商编码,供应商编码]③返回参数：平台标准返回格式，无法自定义删除/提交/撤销/审核/反审核/启用/禁用操作API的配置过程基本一致。删除接口示例：https://vip.kingdee.com/article/264036260484991744④内部公开请勿外传9空操作API-示例：冲销已审核凭证在金蝶云苍穹PaaS平台中，还有一种特殊的操作【空操作】，这种可以执行操作全过程，但没有实际功能处理，适合插件扩展业务逻辑，比如凭证冲销、采购订单变更、行政组织封存等。①请求参数：编码②查询条件：凭证编码=“编码”③返回参数：平台标准返回格式，无法自定义0310总结④内部公开请勿外传11总结（一）操作API有以下特点：无需开发，业务人员即可快速配置；覆盖常见单据和基础资料的增删改查等接口集成场景，大幅降低系统集成交付成本。配置项：第三方应用授权：外部系统必须通过第三方应用appId获取登录令牌，才允许调用接口，无法匿名调用。出参仅返回data域：返回参数只返回data域下的参数，不返回status、errorCode、message。返回动态对象：适用查询操作API，返回参数会展示成DynamicObject的序列化数据。启用查询权限控制：适用查询操作API，会校验当前调用接口用户的组织权限和数据规则，对查询出的数据进行数据隔离。最大分录限制：适用保存操作API，可配置最大分录数量，防止分录过多造成接口超时。请求头：accesstoken请求令牌；Content-Type内容类型；Idempotency-Key防重复调用参数，非必传。Accesstoken认证是最常用的接口认证方式；OpenAPI支持http和soap协议，能解析json、xml、soap1.1、soap1.2等多种报文格式；在请求头中传入唯一的Idempotency-Key，可有效防止接口重复调用。基本信息：请求方式：GET/POST。操作方式：支持业务对象所有操作，如查询、保存、删除、审核等以及空操作。④内部公开请勿外传12总结（二）请求参数：保存操作API只能从业务对象中添加参数，其他非保存操作API支持手工自定义新增和从对象中添加参数。查询操作API必传分页参数：条数pageSize、页码pageNo。查询操作API可将请求参数默认值设为”*”,当调用方不传该参数时，会忽略这个参数及对应的查询条件。返回参数：仅查询操作API可由用户自定义返回参数data域中的参数字段，其他操作API无法自定义返回参数，建议通过自定义API实现。标准返回参数：data（结果数据）、errorCode（错误码）、message（错误信息）、status（是否成功）。参数控制：定义操作API内部处理逻辑，不影响请求入参，调用方无感知。查询条件：查询、删除、提交、审核等操作API的数据过滤条件，根据调用方传入的请求参数，查找对应的数据并执行操作。操作参数：保存API特殊参数。【importType】：保存类型，new-新增，override-覆盖，overridenew-覆盖新增，接口默认执行覆盖新增逻辑。【firePropChanged】：保存时触发值更新事件，true-触发，false-不触发。【forcedSubmit】：保存自动提交。Submit-提交，空-不提交。【OverrideEntry】：更新时完整覆盖分录，会将原单据或基础资料的分录数据清除后追加分录。true-覆盖，false-不覆盖。接口超时解决方法：一次API请求数据量不要太大（例如建议单次请求含分录数2000条/次，最大不超过1万条/次），并对查询接口做分页处理；实体操作查询API的查询条件或实体保存API的候选键，必须建立索引，否则执行全表扫描性能极差。1993-2022金蝶国际软件集团有限公司④内部公开请勿外传特别声明ClaimofConfidential本文件内容为④内部公开请勿外传：禁止未授权的内部、第三方人员使用与访问非专项必要的业务与项目负责人，收到此内容请立即删除严禁在未经过主管领导审批，发送给无关业务团队与人员特别声明ClaimofConfidential•1993-2022金蝶国际软件集团有限公司。保留一切权利。•未经金蝶国际软件集团有限公司的书面许可，任何单位或个人不得以任何形式或为任何目的复制或传播本文档的任何内容。本文档中包含的信息如有更改，恕不另行通知。•本文档提到的金蝶®、金蝶云®、金蝶云EBC®、金蝶云苍穹®、金蝶云星瀚®、金蝶云星空®、金蝶云星辰®、金蝶KIS®、K/3®、金蝶EAS®、友商网®、Apusic®和其它金蝶产品和服务以及它们各自的徽标均为金蝶软件（中国）有限公司或其关联公司在中国和其他国家或地区的商标或注册商标。本文档提到的所有其它产品和服务名称分别为它们各自公司的商标。•本文档所用数据均为虚构的模拟数据，不代表任何一家企业的真实情况，如有权利人认为文档中的任何内容存在侵权情况，请反馈给金蝶官方邮箱（DataSubjectRequest@kingdee.com），我们将在15个工作日内处理。•注：①②机密信息严禁泄露③秘密信息严禁泄露④内部公开请勿外传
