1993-2021金蝶国际软件集团有限公司④内部公开请勿外传开放平台服务部金蝶云·苍穹产品分享2022.12.14——苍穹开发服务云开放平台2提纲01开放平台整体介绍02开放平台功能介绍1、第三方应用2、API管理3、监控统计4、参数配置03典型案例分享1、产品理念2、应用蓝图3、特性介绍3产品理念苍穹开放平台致力于提供基于Restful规范的OpenAPI,将企业数据及业务能力API化,全面覆盖各领域开放接口的使用场景,简单、快速、低成本、低风险地实现内外部系统集成和业务能力的开放。常见应用场景:实现资源复用,避免重复“造轮子”;帮助开发人员,提高集成效率;解耦各系统,快速扩展功能。制造管理开放平台配置|发布|注册|认证|调用|监控金蝶云苍穹HR管理供应链管理财务管理..AI服务RPA服务流程服务企业内部应用WebserviceRestful生态应用WebserviceRestful4开放平台应用蓝图公有云、私有云、混合云API管理API开发零代码配置Java插件开发脚本开发RestAPIWebServiceAPI监控运营分析API日志监控统计API治理生命周期管理API目录API文档API规范治理第三方API治理API安全认证鉴权API授权IP白名单数据加密API限流数据脱敏开放门户API中心SDK平台开放性指南开放案例API门户应用市场API交易API市场开发者社区开发指南接口文档技术论坛测试用例在线测试API测试自动化测试路由API路由协议转换负载均衡5序号特性名称所属应用特性价值V5.0新增1零代码配置操作API开放平台提升API开发效率,API规范化、体系化2JAVA类配置注解开发自定义API开放平台帮助客户开发复杂业务场景下的API接口3脚本开发自定义API开放平台帮助客户开发复杂业务场景下的API接口√4一键发布WebService接口开放平台帮助客户满足旧系统API对接√5云更新、导入导出开放平台帮助客户一键同步标准API资源√6API文档开放平台可视化API文档管理,高效便捷,自动生成,帮助用户快速调用接口7API在线测试开放平台实时调试,提升API开发效率8API日志开放平台提升用户体验,帮助快速定位故障9API统计监控开放平台实时监控API执行情况,提升用户体验10API访问控制开放平台提升系统安全性,基于第三方应用进行登录认证、API授权、IP白名单11签名加密开放平台提升系统整体安全性,防篡改,防敏感数据泄露√12限流策略开放平台对第三方频繁接口频率限制,保证系统稳定性开放平台特性总览6特性亮点•基于元数据驱动,支持零代码配置快速发布API,接口出入参遵循页面约束。•使用Java代码插件,解决复杂的业务场景,如调用微服务或对文件流、图像等进行处理。•可在线编辑脚本,实现多个API、微服务、函数库等之间的组合调用,开发便捷,部署灵活。用户价值•提升开发效率:操作API无需代码开发,界面配置生成,方便快捷,上手门槛低。•丰富应用场景:通过脚本自定义API来处理复杂业务场景,拓展OpenAPI的功能。脚本开发API,提供常用的代码片段引用,无需编译部署,即时生效。关键功能特性1-零代码、脚本、插件方式按需开发API企业生态应用SRM系统商旅应用IoT…电商小程序财务云供应链云税务云HR云.开放企业的业务能力零代码配置APIJava插件API脚本发布API无代码快速发布API,提升开发效率多场景集成支持7关键功能特性2-高效集成,多协议覆盖特性亮点•支持丰富的入参格式:Content-Type支持application/json、application/xml;、application/soap+xml、text/xml、multipart/form-data、application/x-www-form-urlencoded、application/octet-stream文件流等。•发布WebService接口:支持将OpenAPI一键发布为WebService接口,支持SOAP1.1、SOAP1.2协议标准。用户价值•异构系统对接:通过OpenAPI能够和多种不同类型的异构系统快速对接,支撑客户企业内部所有使用WebService接口的集成需求。8关键功能特性3–API统计监控特性亮点•记录API调用日志:包括接口出入参,API处理时间,调用者IP及账号等信息,用于日志审计及故障分析。支持使用ES存储,提高查询效率。•按第三方应用、API、时间(天)维度查看API调用次数和响应时间。用户通过统计报表和看板,直观查看、筛选、过滤API服务的调用数据。用户价值•准确完整的API日志和性能稳定的ES日志引擎,支持记录不同级别的接口日志并帮助用户快速追溯错误原因。•提供API接口运行期监控功能,掌握目标偏移情况,提前防控业务可能出现的潜在问题。9关键功能特性4-全面的API安全策略特性亮点•支持多种登录认证方式,用户可根据实际需要选择不同的认证方式,满足企业安全方面的个性化需求。•支持API授权、IP白名单、限流策略等功能,严格控制访问数据权限,避免越权访问造成数据流失。•支持签名加密,有效防止数据被篡改,同时可配置加密策略,对API传输数据进行双向加密。用户价值•灵活便捷:更丰富的认证方式可选,满足不同的安全认证场景。•安全可信:更全面的API安全策略,严密保护企业数据资产安全。安全策略1.多种登录认证方式2.对外部应用授权接口权限3.配置IP白名单4.配置限流策略5.接口数据加密、防篡改6.查询接口数据及日志脱敏7.接口跨域5种认证方式、多层访问控制10提纲01开放平台整体介绍02开放平台功能介绍1、第三方应用2、API管理3、监控统计4、参数配置03典型案例分享1、产品理念2、应用蓝图3、特性介绍11第三方应用-接口认证注册第三方应用是外部系统调用苍穹OpenAPI的必要条件。第三方应用作为外部系统调用苍穹接口的身份标识,拥有登录认证、接口调用、接口授权、IP白名单等功能。最常用的认证方式为Accesstoken认证,还支持无需动态获取认证令牌的基本认证(适用接口回调场景)和安全性更高的JWT认证、摘要认证及签名认证。菜单路径:开发服务云-开放平台-安全策略-第三方应用。注册第三方应用获取appToken获取accessToken调用相关服务退出登录12第三方应用–签名加密使用签名认证+加密策略,对API传输数据加签同时进行双向加密,可以有效防止数据被篡改和敏感信息泄露。代理用户:在签名认证和基本认证模式下,必须维护至少一个代理用户,并根据系统生成的Secretkey进行认证鉴权。加密策略:支持AES和SM4加密算法。签名加密简介:https://vip.kingdee.com/article/38356702611273984013第三方应用-授权/白名单API授权:按第三方应用维度进行权限控制,调用方只允许调用API授权清单范围内的接口,也可以批量授权全部API。IP白名单:提供IP访问控制的配置,只允许白名单范围内的IP访问,提升系统安全性。第三方应用介绍:https://vip.kingdee.com/article/22528623151111500814第三方应用-限流策略限流策略:对第三方应用、API、匿名三种维度的访问进行限流,可维护策略名称、策略描述、限流维度、次数、流控效果等信息,防止第三方频繁调用接口,影响系统稳定性。菜单路径:开发服务云-开放平台-安全策略-限流策略。限流策略介绍:https://vip.kingdee.com/article/32244410257692236815API管理-全生命周期管理开放平台支持从接口创建-测试-发布到禁用下架的全生命周期管理;不同阶段的接口可通过API状态进行区分。菜单路径:开发服务云-开放平台-API管理。创建内测审核发布调用维护禁用/删除状态说明•内测:仅内部使用,禁止客户调用;•发布:正式对外开放;•维护:API将来会被废弃,不推荐使用;但为兼容仍可使用;•禁用:禁止使用。16API管理-操作API(查询)开放平台OpenAPI分为操作API、自定义API两种类型;操作API通过零代码配置模式,将业务对象(单据、基础资料)的操作(保存,提交,查询等)一键发布成为OpenAPI,系统自动生成服务接口及服务契约。查询操作API通过在界面配置请求参数、查询条件及返回参数来定义查询接口具体的功能。 API基本信息维护编码、名称、操作方式、业务对象、应用、请求地址、详细描述等信息 配置项API配置参数信息,如第三方应用授权,匿名访问等 WebService信息配置命名空间、WSDL方法等,一键发布WebService接口 请求参数配置接口的请求头、query参数/请求体参数 参数控制配置查询操作API的filter查询条件及排序,支持按请求入参查询和常量查询(数据过滤) 返回参数平台标准返回格式,用户可配置data域中具体的返回字段 错误码查询接口示例:https://vip.kingdee.com/article/26403231393033523217API管理-操作API(保存/更新)保存操作API可根据入参的不同,可同时执行业务对象的保存、更新、批量保存和批量更新四种操作。候选键作为接口执行更新逻辑的唯一主键,配置请求体参数时需要谨慎选择。一般选id或number/billno作为候选键,也可选择不同字段组合作为候选键。 API基本信息维护编码、名称、操作方式、业务对象、应用、请求地址、详细描述等信息 配置项API配置参数信息,如第三方应用授权,匿名访问等 WebService信息配置命名空间、WSDL方法名等,一键发布WebService接口 请求参数配置接口的请求头、请求体参数 参数控制配置保存操作API的特殊参数,允许用户在保存时对数据进行一些特殊处理,如保存时自动提交等 返回参数平台标准返回格式 错误码保存接口示例:https://vip.kingdee.com/article/26403606987904076818API管理-自定义API(Java插件)自定义API用于拓展平台的API,满足一些个性化的需求,这类API不依附任何业务对象,出入参数可以完全自定义。开发方式:通过Java插件开发,并在开放平台通过简单的接口配置后,系统自动解析出入参数,快速方便地生成自定义API,主要用于处理复杂业务场景。 API基本信息维护所属应用、编码、名称、自定义分类、类名、方法名、请求地址、详细描述等信息 配置项API配置参数信息,如第三方应用授权,匿名访问等 WebService信息配置命名空间、WSDL方法名等,一键发布WebService接口 请求参数根据类名和方法名自动解析 返回参数根据类名和方法名自动解析 错误码自定义API操作手册:https://vip.kingdee.com/article/291996579606116096自定义API发布webservice接口:https://vip.kingdee.com/article/29262596062331417619API管理-自定义API(脚本开发)开发方式:通过API脚本开发,在开放平台API维护界面编辑脚本并发布成API接口,可实现多个API、微服务、函数库等之间的组合调用,开发便捷,部署灵活。 API基本信息维护所属应用、编码、名称、自定义分类、请求地址、详细描述等信息 配置项API配置参数信息,如第三方应用授权,匿名访问等 WebService信息配置命名空间、WSDL方法名等,一键发布WebService接口 请求参数根据需要,手工添加或通过Json导入 返回参数根据需要,手工添加或通过Json导入 错误码20API管理-自定义API(脚本开发)代码片段管理:在开放平台中可以维护自定义API中引用的代码片段,提升接口开发效率。脚本调试:提供了帮助开发人员调试脚本的工具。菜单路径:开发服务云-开放平台-其他-代码片段管理。21API管理-在线测试API在线测试:开放平台可模拟真实数据调用API服务。无需配置Postman,即可完成一键调试。支持JSON、XML、SOAP1.1、SOAP1.2四种格式。API在线测试:https://vip.kingdee.com/article/26438737033652659222API管理–导入导出导入导出:支持API批量导出成dts、zip包、excel、pdf、sql等文件,也可以通过dts文件批量导入API,完成API数据备份和迁移。菜单路径:开发服务云-开放平台-API管理。API在线测试:https://vip.kingdee.com/article/26438737033652659223API管理–云更新云更新:客户按需同步最新标准API至本地环境,所选API不存在即新增,存在即覆盖。无需升级补丁,随时更新,提升接口开发和项目实施效率。菜单路径:开发服务云-开放平台-API管理。24API管理-API文档API文档:展示API接口基本信息、请求参数、请求结构示例、返回参数和返回结构示例、错误码等信息;支持获取匿名链接,无需登录即可查看API文档,帮助开发人员快速上手,提升系统对接效率。菜单路径:开发服务云-开放平台-API文档。25监控统计-API日志API日志:记录API调用日志,包括出入参,API处理时间,调用者IP及账号。用于日志审计及故障分析。使用ES存储,极大提高查询效率,同时支持日志转储及归档。菜单路径:开发服务云-开放平台-监控统计-API日志。API调用日志:https://vip.kingdee.com/article/26399026229134080026监控统计-API统计API统计监控:通过统计信息报表和统计信息看板,让用户更直观的查看、筛选、过滤API服务的调用数据,实时监控目标偏离情况。菜单路径:开发服务云-开放平台-监控统计-API统计。API调用统计:https://vip.kingdee.com/article/26399145367507865627参数配置参数配置:通过参数配置界面,可以设置日志记录级别、是否显示异常stack、查询接口的最大查询数量、限流控制开关等。菜单路径:开发服务云-开放平台-参数配置。开放平台参数配置:https://vip.kingdee.com/article/264031111892565504 系统参数设置参数生效开关,若不开启,则默认以苍穹MC开关为准 API调用日志选择日志记录级别:记录详细日志、记录摘要日志和大文本日志。 显示异常Stack当API服务调用报错时,可以由用户控制是否显示异常堆栈信息 查询参数-最大查询数量单次调用接口的返回数量不允许超过参数值,数量过大时建议分页查询。 打开限流控制控制按第三方应用和API维度的限流策略是否生效。28API&SDK开放门户:https://dev.kingdee.com/index/open/detail/api/开放门户:标准产品发版后,标准OpenAPI自动发布到开放门户。用户可以在开放门户中查看OpenAPI和SDK帮助文档,覆盖财务、供应链、制造、HR、流程等领域接口使用场景。29提纲01开放平台整体介绍02开放平台功能介绍1、第三方应用2、API管理3、监控统计4、参数配置03典型案例分享1、产品理念2、应用蓝图3、特性介绍30OpenAPI+集成云联合解决方案简介:客户是某药企大厂,目前是中药材种植、加工、中、西成药研发、生产、批发、零售连锁经营以及医疗产业为一体的大型股份制医药企业集团。目标1.通过开放平台与集成服务云实现金蝶云苍穹与SAPHANA、WMS、MRP等历史遗留系统及数十个外围系统及客户对接。2.接口保留原生SAPWebService的格式,仅仅做出地址的变动,客户做到无感切换WebService,帮助客户完成SAP系统国产化替代。3.实时掌握API调用情况,洞察企业内资源价值,获得接口运营洞察能力,进一步优化流程。价值 WebService低代码化发布受客户和开发人员一致好评,极大的简化了开发步骤,50+的WebService两个小时可全部开发完成,算上后续业务处理全链路仅需三周时间,开发效率指数级提升。 异构系统对接,接口动态调配,一键发布实时监控。通过集成服务云和开放平台提供统一的,轻量级的系统集成和API管理平台,对接效率大大提升。31OpenAPI+集成云联合解决方案数据集成•通过金蝶云苍穹WebService,处理大数据量的数据集成,每日处理1.287亿+条数据同步请求•按月调用OpenAPI近600万次+,累计调用2800万次+•开放平台运行稳定,无一次生产中断事故项目成果 项目全面替换核心SAPECC系统,集成系统20+套,接口数260+个。覆盖批发、零售、采购、库存、GSP、财务等领域。 配置化发布WebService服务功能,极大提升开发效率:1)对比行业ESB产品开发效率提升5倍2)对比SAPPI开发效率提升8倍 在线接口测试功能,大幅提升开发调试效率。 轻量级的系统集成和API管理一体化平台:开发、测试、发布、管理、监控。32XX集团-基于API实现数据共享,助力业财一体化简介:客户是某大型集团,是中央直接管理的国有重要骨干企业。主营业务包含先进制造与技术服务、医药医疗健康、贸易与工程服务三大主业,多次入围《财富》世界500强。目标1.建立统一的数据标准,加强对业务财务一体化应用及统一经营决策分析发支撑作用2.构建主数据管理平台,统一数据录入口径,实现跨部门数据管理有效协同3.通过API实现数据的线上集成交互,为数据集中化管理奠定基础,建立财务系统和业务系统之间的关联性,实现业财一体化。价值 丰富的报文格式和协议支持,帮助快速适配更多的异构系统;通过第三方应用访问控制保护企业数据安全,简化系统协同,系统对接 帮助企业打通业务与财务数据,数据流实现闭环;降低跨部门协作难度,为企业积累核心数据资产,并且为未来管理的优化提供了基础数据依据。33XX集团-基于API实现数据共享,助力业财一体化信息描述统计结果对接系统SAP、Oracle、主数据、贸易系统、SRM等17个系统接口数量171+API,主要通过Java插件开发和零代码配置的模式解决方案RestfulAPI+中间表,直接对数据库进行读写操作。中间表机制既能保证数据安全性,又能对异常接口报文进行重试补偿。API接口列表通过OpenAPI快速实现数据开放和共享效率,按需调用,安全灵活。第三方应用(对接系统)列表34苍穹知识学习渠道【开发者社区】:https://developer.kingdee.com金蝶云苍穹|开发者社区“帮助文档、交流门户”微信扫码关注,每天解锁新技巧PaaS平台那些事公众号“官方技术型干货公众号”金蝶云·苍穹公众号“官方品牌动态公众号”微信扫码关注,了解苍穹新资讯1993-2021金蝶国际软件集团有限公司ThanksTerimakasih感谢谢谢ありがとうขอบคุณ36没有金蝶软件国际软件集团有限公司的特别许可,任何人不能以任何形式或为任何目的复制或传播本文档的任何部分。本文档中包含的信息如有更改,恕不另行通知。由金蝶软件(中国)有限公司和其分销商所销售的某些软件产品包含有其它软件供应商的软件组件。Microsoft®、WINDOWS®、NT®、EXCEL®、Word®、PowerPoint®和SQLServer®是微软公司的注册商标。IBM®、DB2®、DB2通用数据库、OS/2®、ParallelSysplex®、MVS/ESA、AIX®、S/390®、AS/400®、OS/390®、OS/400®、iSeries、pSeries、xSeries、zSeries、z/OS、AFP、IntelligentMiner、WebSphere®、Netfinity®、Tivoli®、Informix和Informix®动态ServerTM是国际商业机器公司在美国或其他公司的商标。ORACLE®是ORACLE公司的注册商标。UNIX®是UNIXINTERNATIONALCO.,LIMTED的注册商标、OSF/1®和Motif®是OpenGroup的注册商标。Citrix®、Citrix徽标、ICA、ProgramNeighborhood®、MetaFrame®、WinFrame®、VideoFrame®、MultiWin®以及此处引用的Citrix产品名是CitrixSystems公司的商标或注册商标。HTML是HATEMOGLUTEKSTILGIYIMSANAYIVETICARETA.S.的注册商标,DHTML、XML和XHTML是W3C®、WorldWideWeb协会、计算机科学实验室的商标或注册商标,PureXML是国际商业机器公司的注册商标。JAVA®是甲骨文美国有限公司的注册商标。JAVASCRIPT®是甲骨文美国有限公司的注册商标,由其技术开发和实施商Netscape许可使用。Apusic®是深圳市金蝶中间件有限公司的注册商标。本文档提到的金蝶®、金蝶KIS®、K/3®、金蝶EAS®、友商网®和其它金蝶产品和服务以及它们各自的徽标是金蝶软件(中国)有限公司在中国和世界其它一些国家的商标或注册商标。本文档提到的所有其它产品和服务名称是它们各自公司的商标。本文档所用数据均为虚构的模拟数据,不代表任何一家企业的真实情况,如有权利人认为文档中的任何内容存在侵权情况,请反馈给金蝶官方邮箱(DataSubjectRequest@kingdee.com),我们将在15个工作日内处理。特别声明