应用方案手册【OpenAPI管理】YonBIPV3.0(R5_2312_1)高级版用友网络科技股份有限公司用友网络科技股份有限公司1手册用友商业创新平台版权©用友集团版权所有未经用友集团的书面许可，本应用方案手册任何整体或部分的内容不得被复制、复印、翻译或缩减以用于任何目的。本应用方案手册的内容在未经通知的情形下可能会发生改变，敬请留意。请注意：本应用方案手册的内容并不代表用友所做的承诺。用友网络科技股份有限公司用友网络科技股份有限公司2手册用友商业创新平台目录版权................................................................................................................................................................................1变更记录........................................................................................................................................................................4名词解释......................................................................................................................................错误！未定义书签。第一章整体概述..........................................................................................................................................................51.1总体概述.......................................................................................................................错误！未定义书签。1.2应用概述.........................................................................................................................................................51.3应用价值.........................................................................................................................................................5第二章应用角色........................................................................................................................错误！未定义书签。第三章应用地图..........................................................................................................................................................5第四章应用场景..........................................................................................................................................................64.1凭证归档..........................................................................................................................................................64.1.1业务描述..............................................................................................................................................64.1.2业务流程..............................................................................................................................................64.1.3应用点清单..........................................................................................................................................64.1.4应用解决方案......................................................................................................................................7第六章注意事项........................................................................................................................错误！未定义书签。用友网络科技股份有限公司用友网络科技股份有限公司3手册用友商业创新平台导读此手册面向实施顾问以及企业关键用户，旨在为实施规划、解决方案制定和落实提供指导。手册围绕OpenAPI管理功能展开，完整描述OpenAPI使用的步骤及逻辑。本手册包括三大部分；第一部分是对产品的概要介绍；第二部分是对应用点分布情况的地图清单；第三部分是对系统应用步骤的详细介绍。用友网络科技股份有限公司用友网络科技股份有限公司4手册用友商业创新平台变更记录编写人版本修订人审核人起止时间修订/审核章节修订/审核内容用友网络科技股份有限公司用友网络科技股份有限公司5手册用友商业创新平台第一章整体概述1.1应用概述API（ApplicationProgrammingInterface，应用编程接口）可供第三方开发者使用，开放的API称作OpenAPI（开放API）。YonBIP高级版提供丰富多样的OpenAPI，包括如下领域：动态建模平台、供应链、财务会计、经营会计、财资、资金、资产、共享服务、预算报表等。1.2应用价值1.对第三方应用提供灵活多样的OpenAPI，丰富业务使用场景，扩大YonBIP高级版产品生态圈。2.支持OpenAPI在线定制、代码生成、测试、展示全流程管理。3.积极有效管理第三方应用使用API，做好业务数据管控。4.提供详细业务日志，便于及时掌握调用的有效性。5.提供可视化维护OpenAPI黑白名单管理及相关后台参数控制。第二章应用地图OpenAPI管理属于开放集成平台，包括三个功能节点：OpenAPI维护、OpenAPI应用管理、OpenAPI日志、OpenAPI参数设置。产品领域产品模块功能开放集成平台OpenAPI管理OpenAPI维护开放集成平台OpenAPI管理OpenAPI应用管理开放集成平台OpenAPI管理OpenAPI日志开放集成平台OpenAPI管理OpenAPI参数设置注：OpenAPI参数设置只有系统管理员可见，其他节点系统管理员及业务用户均可显示。用友网络科技股份有限公司用友网络科技股份有限公司6手册用友商业创新平台第三章应用场景OpenAPI管理主要应用场景包含以下几个方面：1.OpenAPI信息维护为第三方应用提供灵活多样的OpenAPI，丰富业务使用场景，扩大YonBIP高级版产品生态圈。实现OpenAPI在线定制、代码生成、测试、展示全流程管理。2.OpenAPI应用管理有效管理第三方应用使用API，做好业务数据管控。3.OpenAPI日志管理提供详细业务日志，便于及时掌握OpenAPI调用的情况。4.OpenAPI参数设置在第三方调用OpenAPI时，对超期时长、熔断配置、黑白名单等做相应控制，便于对OpenAPI调用的管控。3.1OpenAPI维护3.1.1业务描述在领域和模块下新增OpenAPI分组，可对分组信息的编辑和删除。在分组下注册或复制新的OpenAPI信息，维护请求参数、返回参数及相关示例，对已注册的OpenAPI信息维护其结构化参数。结构化展示OpenAPI参数及示例信息。在非正式环境下对OpenAPI进行在线测试、生成代码。3.1.2业务流程无。3.1.3应用点清单领域产品模块应用页面开放集成平台OpenAPI管理OpenAPI维护OpenAPI维护用友网络科技股份有限公司用友网络科技股份有限公司7手册用友商业创新平台3.1.4应用解决方案1.新建OpenAPI分组在左侧OpenAPI树中，选择模块下建立分组，填写分组编码、名称、所属模块。图3.1-1新增分组2.注册OpenAPI信息在左侧OpenAPI树中，选择某分组，在其下新增OpenAPI信息。填写编码、名称、请求url、所属模块、所属分组、MD地址、使用场景、描述。图3.1-2新增OpenAPI第一步点击【下一步】，填写请求参数。请求参数可通过【引入元数据】的方式选择元数据属性作为请求参数。也可点击【新增参数】按钮，手工添加参数，包含参数名称、类型、说明、默认值、是否必填信息。支持用友网络科技股份有限公司用友网络科技股份有限公司8手册用友商业创新平台参数上移、下移、插入新参数等操作。此外，还可以通过【参数定义JSON导入】，填写JSON字符串，系统会将其解析为请求参数，生成后，可以按需要手工调整。参数维护完成后，可通过下方的生成示例，自动按照请求参数生成对应的请求示例。图3.1-3新增OpenAPI第二步点击【下一步】，填写返回参数。操作方式与请求参数相似。参数维护完成后，可通过下方的生成示例，自动按照请求参数生成对应的返回示例。另外，还可维护并定义错误码，作为OpenAPI的返回信息。完成后，点击【保存】按钮，完成OpenAPI定制业务。图3.1-4新增OpenAPI第三步如需创建一个与某个OpenAPI相似的信息，可进行复制功能，左树选择某个OpenAPI，点击【复制】，可生成复制向导，系统会默认带出分组和模块，并将请求参数、返回参数均带入向导中，可根据需要手工调整。用友网络科技股份有限公司用友网络科技股份有限公司9手册用友商业创新平台图3.1-5复制OpenAPI选择左树OpenAPI信息后，右侧显示该OpenAPI的请求地址、请求参数、请求示例、返回参数、返回参数示例、错误代码。图3.1-6浏览OpenAPI如需对OpenAPI进行在线测试，需在非正式环境（临时lisence授权）中进行测试。测试时，选择左树OpenAPI，点击界面右上方【测试】按钮，显示在如下界面测试界面。参考右侧OpenAPI参数信息，将请求数据通过手工填写或请求JSON导入，点击【测试】按钮，系统将按照请求数据传入给该OpenAPI，可在响应结果查看调用的结果。如对自定义的OpenAPI需要生成模板代码，可通过生成代码功能实现OpenAPI代码包的下载，可供客开后续开发使用。用友网络科技股份有限公司用友网络科技股份有限公司10手册用友商业创新平台图3.1-6测试OpenAPI3.2OpenAPI应用管理3.2.1业务描述维护使用OpenAPI接口的第三方应用的信息，并对第三方应用信息记录其对应关联的API信息。支持第三方应用信息的启用和停用操作。3.2.2业务流程无。3.2.3应用点清单领域产品模块应用页面开放集成平台OpenAPI管理OpenAPI应用管理OpenAPI应用维护3.2.4应用解决方案1.新建OpenAPI应用新增OpenAPI应用信息，填写应用编码、应用名称、用户编码、加密类型等信息。用友网络科技股份有限公司用友网络科技股份有限公司11手册用友商业创新平台图3.2-1新增应用信息保存后，生成应用密文和公钥。图3.2-2新增应用信息2.关联API在当前启用的应用下，选择该应用可访问的OpenAPI，并进行关联操作。关联后，该第三方应用就可以使用所选的OpenAPI。用友网络科技股份有限公司用友网络科技股份有限公司12手册用友商业创新平台图3.2-3关联API3.3OpenAPI日志3.3.1业务描述当OpenAPI被调用后，如出现问题或查询被调用情况，可按应用名称、API名称、访问时间段查询相应的日志信息。3.3.2业务流程无。3.3.3应用点清单领域产品模块应用页面开放集成平台OpenAPI管理OpenAPI日志OpenAPI日志查询用友网络科技股份有限公司用友网络科技股份有限公司13手册用友商业创新平台3.3.4应用解决方案1.查询OpenAPI调用日志根据OpenAPI应用信息或API名称等信息可快速查询日志调用情况，包括访问IP、访问时间、报文信息，如有错误信息，可通过业务报错信息详细了解。图3.3-1日志查询3.4OpenAPI参数设置3.4.1业务描述在第三方调用OpenAPI时，对超期时长、熔断配置、黑白名单等做相应控制，提供相应配置功能，便于对OpenAPI调用的管控。3.4.2业务流程无。3.4.3应用点清单领域产品模块应用页面开放集成平台OpenAPI管理OpenAPI参数设置OpenAPI参数设置用友网络科技股份有限公司用友网络科技股份有限公司14手册用友商业创新平台3.4.4应用解决方案1.参数设置系统管理员对OpenAPI调用时根据黑白名单，对其调用有效拦截或开通，同时可对其相关调用阀值有效管理。图3.4-1用友网络科技股份有限公司用友网络科技股份有限公司15手册用友商业创新平台用友网络科技股份有限公司YonyouNetworkTechCo.Ltd.用友网络科技股份有限公司
