YonBIPV3.0(R6_2407_1)旗舰版云平台-连接集成平台-API网关用友网络科技股份有限公司2024年9月用户手册1/44版权©2024用友集团版权所有。未经用友集团的书面许可，本用户手册任何整体或部分的内容不得被复制、复印、翻译或缩减以用于任何目的。本用户手册的内容在未经通知的情形下可能会发生改变，敬请留意。请注意：本用户手册的内容并不代表用友网络所做的承诺。用户手册2/44目录第一章总体概述..............................................................5第二章应用价值..............................................................5第三章发布API...............................................................53.1总体概述..............................................................53.2总体价值..............................................................53.3相关内容..............................................................53.4API发布...............................................................53.4.1功能描述...............................................53.4.2业务规则...............................................63.4.3操作说明...............................................6第四章调用API..............................................................164.1总体概述.............................................................164.2总体价值.............................................................164.3API调用..............................................................174.3.1功能描述..............................................174.3.2业务规则..............................................174.3.3栏目说明..............................................174.3.4操作说明..............................................194.4API文档..............................................................244.4.1功能描述..............................................244.4.2业务规则..............................................254.4.3操作说明..............................................254.5API路由..............................................................284.5.1功能描述..............................................284.5.2业务规则..............................................294.5.3操作说明..............................................29第五章安全策略.............................................................32用户手册3/445.1IP访问控制...........................................................325.1.1功能描述..............................................325.1.2业务规则..............................................335.1.3栏目说明..............................................335.1.4操作说明..............................................335.2限流控制.............................................................335.2.1功能描述..............................................335.2.2业务规则..............................................345.2.3栏目说明..............................................345.2.4操作说明..............................................34第六章事件订阅.............................................................356.1事件文档.............................................................356.1.1功能描述..............................................356.1.2关键应用..............................................356.1.3操作说明..............................................356.2事件日志.............................................................376.2.1功能描述..............................................376.2.2关键应用..............................................376.2.3字段说明..............................................376.2.4操作说明..............................................376.3事件订阅.............................................................386.3.1功能描述..............................................396.3.2业务规则..............................................396.3.3栏目说明..............................................396.3.4操作说明..............................................406.4网关设置.............................................................426.4.1总体概述..............................................426.4.2总体价值..............................................42用户手册4/446.4.3相关内容..............................................43用户手册5/44第一章总体概述API网关提供API的全生命周期的管理，包括创建、维护、发布、运行、下线等，包括产品管理、参数对象、API发布、插件管理、API日志、API文档、API接入申请、授权KEY管理、IP访问控制、限流控制、熔断控制、API注册审核、API监控等。第二章应用价值API网关旨在为企业中台化建设，提供统一能力的管理平台。第三章发布API3.1总体概述为租户提供API发布能力，租户可以进行建造产品分类、产品、API分类之后，进行API发布。3.2总体价值租户可以在此发布系统内部接口，进行API全生命周期管理；可以发布接口同步给客开或者第三方开发者进行使用。3.3相关内容•产品定义•API发布3.4API发布3.4.1功能描述用户手册6/44API发布支持API的新增、导入、编辑、删除、发布、取消发布、访问控制、生成文档文档等操作。API分类层级为，集成系统-API分类-API。API发布包含开放API和集成API：开放API：开放API即OpenAPI，客户和生态ISV可通过API授权进行安全调用。集成API：集成API是指在连接器中使用的API，用于企业完成集成业务。3.4.2业务规则•产品查询\查看：支持按照API名称、发布状态、集成API搜索查询。•API发布：支持API的新增、Json导入、Json导出、swagger导入，支持API的批量发布、取消发布，支持API文档的生成，支持API测试，查看API日志和监控。3.4.3操作说明•API搜索查询：输入API名称关键词，回车或点击搜索图标搜索查询满足条件的API。【图】API搜索用户手册7/44•新增API分类：API分类第一级是集成系统，系统默认创建YonBIP集成系统。您可根据公司使用的系统进行定义。您可以选择在集成系统【增加平级分类】。集成系统用于全面管理集成业务，如监控、分析、运维等。用户手册8/44创建完一级分类后，根据业务创建下级分类。点击【新增下级分类】按钮。用户手册9/44•新增API：选择三级分类，创建点击【新增】按钮，•选择向导式新增。进入添加API页面，新增API包括填写基本信息定义API请求定义API后端服务三个步骤。Step1:选择后端服务类型，目前支持REST、YonBIP、Webservice、自定义四种类型。REST:后端服务为标准的HTTP(s)协议接口，网关会通过HTTP协议调用后端服务YonBIP:后端服务为用友YonBIP的HTTP接口，YonBIP接口对请求有特殊的鉴权和加签要求，详细说明请参考文档Webservice：后端服务为webservice服务，需要在后端服务请求地址里输入webservice的调用地址，调用方需要将调用后端服务的请求地址改为网关对外的请求地址自定义：非以上网关支持i的后端服务，API发布者可以通过扩展开发业务扩展插件的方式支持调用后端服务用户手册10/44【图】选择后端服务类型Step2：填写基本信息•API名称：填写API的名称，建议名称见名思义，能够通过名称就能知道该api的用途。•API分类：API的分类。•应用场景：默认是开放API，如果需要在集成场景使用，需要勾选集成API。如果您想在非【YonBIP集成系统】之外的集成系统中发布集成API，需要将集成系统关联连接配置。目前仅支持旗舰版连接配置下发布集成API。•API类别：如果选择集成API需要选择API类别。•API描述：描述该API的使用场景以及其他说明。用户手册11/44【图】填写基本信息Step3:定义API请求【图】定义API请求•完整发布地址：开放平台对外公开的地址，不可编辑，域名+分类路径+请求路径组成完整的API发布地址。•域名：开发平台API对外调用的域名，不可编辑。•分类路径：API所属产品线和产品的编码作为API发布地址的一部分。•请求路径：接口请求的路径，用户手工输入，建议该地址见名思意，能根据地址看出来接口用途，格式如：/users/{userId}/projects，{}中的变量为请求参数，表示匹配”/“之间的一整段，不支持匹配”/“之间的一部分，例如/abc{userId}；请求Path中包含请求参数时，必须设置对应的入参定义。•匹配所有子路径：调用的请求路径将以创建时填写的API请求路径为前缀，支持接口定义多个不同Path。•例如：请求路径为/test/AA，使用匹配所有子路径时，通过/test/AA/BB、test/AA/CC都可以访问，但是通过/test/AACC无法访问。•ContentType：内容类型，可根据实际情况选择，默认为：application/json。•请求类型：支持GET、POST、PUT、DELETE、ANY（表示该API支持任意请求方法）。用户手册12/44•body透传:当选择为true网关只做body参数的转发，不做body参数过滤和映射。•请求参数：可定义接口的请求参数。可配置参数的数据类型、是否数组、参数位置、默认值、是否必填、描述、用户可见(为false，则在文档中不可见，默认为true).建议参数的描述和是否必填一定要写清楚，这样用户在看文档的时候能清晰的知道该参数的含义，以及是否必须传入。•名称：参数的名称，如果参数在“PATH”位置，那么参数名称需要和“请求路径”中的名称相同。•类型：字段的类型，包括String、int、long、boolean、object等，其中object表示对象类型，可以为子参数，并且只有参数位置为Body时显示。•是否数组：标记参数是否是数组。•描述：参数的中文描述，建议参数的描述一定要写清楚，让API调用方在文档中能清晰的知道该参数的含义。数值类型建议标记精度、字符串类型建议标记最大长度、若值为枚举的建议在描述中标记所有枚举值和说明。•默认值：“必填”为“否”时，默认值生效。请求中不包含此参数时，API网关自动增加默认值发送给后端服务。•是否必填：请求API时，此参数是否为必填。如果选择“是”，API网关将校验请求中是否包含此参数，如果不包含，则拒绝该请求。•用户可见：设置成不可见，则在API文档中用户看不到此参数。•示例：参数值的填写示例，建议填写。•参数验证：参数验证正则表达式，若要对参数验证格式可以在此录入相应的正则表达式。•请求示例：该示例必填，会展示在文档中，用户可以参考该示例调用接口。•参数拓展：参数拓展按钮，专为支持与租户级拓展对象的高效交互而设计，仅用于YonBIP分类场景下。开启参数后，API定义直接关联到业务对象B。当API调用发生，后端服务可以接收包含拓展字段的数据，进而将其正确入库。且API文档可以展示业务对象的拓展信息。•请求参数是否展示扩展：如果选该参数，仅在请求参数内增加扩展字段。•返回参数是否展示扩展：如果选该参数，仅在返回参数内增加扩展字段。用户手册13/44•扩展参数是否放在customExtend：如果选该参数，由customExtend封装后传递扩展参数。例如：customExtend{“A”:”code”}。如果您定义的API是集成API且API类别是列表查询，需要额外标识参数，进行数据集成1.起始页码：指定查询的起始页码。2.分页大小：定义每页显示的记录数量。3.起始时间：设置查询的起始时间点。Step4:定义后端服务参数【图】定义API后端服务后端请求地址：后端服务的路径，可以包含路径参数，以{路径参数}形式表示，比如getUserInfo/{userId}，并要求路径参数要保持和请求参数定义的路径参数名一致。后端请求类型：支持GET、POST、PUT、DELETE、ANY（表示该API支持任意请求方法）。后端超时时间：请求超时时间，建议1~180秒。默认10秒。常量参数：如果后端服务需要接收API调用者不可见的常量，可以通过设置常量参数来实现。API网关在请求后端服务时，将常量参数增加到指定请求位置，并将请求发送给后端服务。用户手册14/44后端请求参数映射：网关会根据该参数映射，进行入参和到后端参数的映射。当对外暴露的参数名称，参数位置和后端真实参数名、参数位置不同时，可使用该配置进行映射。后端返回结果定义：该接口的返回值定义，需明确定义返回值参数名称、描述、类型、是否数组以及示例。•名称：参数的名称。•类型：字段的类型，包括String、int、long、boolean、object等，其中object表示对象类型，可以为子参数。•是否数组：标记参数是否是数组。•描述：参数的中文描述，建议参数的描述一定要写清楚，让API调用方在文档中能清晰的知道该参数的含义。数值类型建议标记精度、字符串类型建议标记最大长度、若值为枚举的建议在描述中标记所有枚举值和说明。•示例：参数值的填写示例，建议填写。高级选项：•业务扩展插件：业务扩展插件可以让API开发者在平台访问后端服务和将后端服务返回值返回前插入自定义的业务代码进行扩展。例如可以根据后端服务的鉴权要求增加鉴权参数的处理。•返回值插件：网关规范要求API返回值标准格式必须是JSON对象，对象属性包括：1.code：状态码，正确返回值为2002.message：提示信息，当code不为200时，出示错误信息，非必选项3.data：后端服务返回的数据部分，非必选项示例:{“code”:”200”,”message”:”xxxxxxxxxx”,”data”:{“name”:”zhangsan”,”age”:20}}若后端服务返回值不是此结构，就需要通过开发自定义的【返回值解析插件】进行转换若后端服务返回结构是JSON对象，也有状态码、提示信息和数据参数，仅仅是参数名不是code、message和data，平台提供【返回值参数映射插件】，用户无需开发新的插件，只需维护参数映射关系即可。用户手册15/44设置为Mock返回结果：将正确返回示例设置为Mock返回值。Mock一般用于开发调试验证。在项目初始阶段，后端服务没有搭建好API联调环境，可以使用Mock模式，将预期结果固定返回给API调用方，方便调用方进行项目开发。延时：设置为Mock返回结果为true时显示，默认为0，0表示不延迟，其他值时，网关会延迟设置的时长后才返回mock数据。正确返回示例生成示例：成功调用API时，返回的响应信息示例错误返回示例：调用API失败时，返回的响应信息示例。错误码：API返回的错误码列表，可以让调用方明确知道错误原因和解决方案。编辑API：点击【编辑】按钮，可对API信息进行修改注：发布过的API，编辑保存后，需要点击重新发布才能生效。编辑步骤与API新增类似。•删除API：只有未发布的API才可以删除，ps:删除API操作将删除数据，请谨慎操作。•发布：在API列表中点击某API的<发布>按钮后，将修改API状态为发布状态，则调用方可以访问，只有发布的API才能生成文档。API为发布状态的情况进行了编辑，保存后，修改的部分将不会生效，只有【重新发布】后才生效。如不需要向用户展示可以进行【取消发布】操作，取消发布后所有调用方将无法调用此API。同时为管理者提供了批量发布、批量取消发布的操作功能。提供批量【生成文档】功能，点击<生成文档>按钮，系统将自动将此产品下的已发布的全部API生成文档，并可通过API文档进行查看。•访问控制：可为某API个性化设置访问控制，在产品下的API列表页中点击<访问控制>按钮，进入访问控制管理页面，如下图：用户手册16/44【图】访问控制注：点击添加可从插件列表中选择需要使用的插件，添加后可进行删除、启用/停用；点击<添加>将显示由插件管理节点维护的插件类型为访问控制插件，插件等级为API的插件。第四章调用API4.1总体概述企业通过调用API来快速授权第三方应用调用云服务的API，为第三方应用分配能够通过AppKey，AppSecret来安全调用YonSuite的API，租户可通过此模块的管理能力来有效控制调用方。4.2总体价值•API调用提供调用方的授权管理及针对授权KEY安全策略的设置。用户手册17/44•API文档通过API文档可全方位的了解YonSuite的API说明。4.3API调用4.3.1功能描述为API调用方授权，分配AppKey、AppSecret，调用方通过AppKey、AppSecret来调用由网关开放的API，网关通过AppKey、AppSecret来进行鉴权，保护API的合法访问，保护数据的安全。4.3.2业务规则•添加和修改授权Key自动生成全局唯一的AppKey和AppSecret；AppKey不允许修改；AppSecret支持重新生成。•API授权为AppKey分配可访问的OpenAPI，包括原厂、服务商和内部API。•事件订阅为AppKey订阅开放平台公开的各类事件类型（如更改人员信息、更改组织机构等），一旦数据发生变动，开放平台会将企业租户变动数据推送给应用后台接口，应用后台进行数据同步。4.3.3栏目说明授权Key信息：栏目名称说明用户手册18/44授权KEY描述授权KEY的描述信息AppKey全局唯一的AppKey标识AppSecretAppKey对应的密钥信息，可重新生成API授权信息：栏目名称说明授权Key授权KeyAPI主键授权的API主键类型原厂、服务商、内部事件订阅信息：栏目名称说明授权Key授权Key回调地址开放平台推送事件的地址，需要保证可以在公网访问，在保存订阅信息时，开放平台会向该地址推送测试事件，以验证回调地址的有效性。开发人员在开发事件订阅接口时可使用测试按钮推送测试事件，待测试事件推送成功后，再订阅具体的业务事件。必填项。预警邮箱事件推送失败，开放平台会向此邮箱发送邮件限流策略设置推送的限流策略。0标识不限流。重试次数推送失败重试次数订阅的事件列表已订阅的事件列表访问控制：栏目名称说明授权Key授权Key插件ID应用级别的插件类型，包括：API授权、应用级限流、IP访问控制访问控制：用户手册19/44栏目名称说明授权Key授权Key插件ID应用级别的插件类型，包括：API授权、应用级限流、IP访问控制执行顺序多个访问控制的执行顺序访问控制策略关联的访问控制策略状态启用、禁用4.3.4操作说明4.3.4.1新增授权KEY进入API调用页面，点击左上角的<添加>按钮，弹出维护窗口，填写授权KEY描述，点击<保存>完成添加，授权KEY描述一般为调用方的描述信息，例如:MES系统供应链API调用。操作界面如下图：新增授权KEY注：可点击图标来查看AppSecret，可点击重置来重新生成AppSecret。用户手册20/444.3.4.2API授权为此授权KEY授予可调用的API，点击
按钮进入API授权页面，显示已经授权的API，点击<新增API>下拉选择【用友开放API】、【服务商API】、【内部API】，其中【用友开放API】表示用友原厂开放的API，【服务商API】表示服务商开放的API，内部API表示当前租户自己开放的API；进入选择API页面，选择需要授权的API，可多选，点击<确定>完成API的授权，在API授权页面可查看API详情，也可删除某API的授权。已授权的API用户手册21/44新增API授权4.3.4.3事件订阅为此授权KEY订阅事件，点击<事件订阅>按钮进入事件订阅页面，显示订阅的基本信息和已经订阅的事件。订阅的基本信息包括回调地址、预警邮箱、限流配置和重试次数。【回调地址】是开放平台推送事件的地址，需要保证可以在公网访问，在保存订阅信息时，开放平台会向该地址推送测试事件，以验证回调地址的有效性。开发人员在开发事件订阅接口时可使用测试按钮推送测试事件，待测试事件推送成功后，再订阅具体的业务事件。【预警邮箱】：事件订阅推送失败会向此邮箱。【限流配置】：可配置多少秒内推送的次数，以免将应用后端服务压力过大。【重试次数】：可配置推送失败重新发送的次数。点击<新增订阅>，进入新增订阅页面，选择需要订阅的事件，可多选，点击<确定>完成事件的订阅，在事件订阅页面可删除已订阅的事件。用户手册22/44已订阅事件新增订阅4.3.4.4访问控制为此授权KEY进行应用级别的访问控制，包括API授权、限流和IP访问控制。用户手册23/44点击<访问控制>按钮进入访问控制页面，显示已有的访问控制插件，可以删除、启停用、排序和关联策略。点击<添加>可从访问控制插件列表中选择需要使用的应用级别的访问控制插件。【API授权】：添加后，则此AppKey访问的API时必须先进行API授权后才允许访问，若不配置，则访问API时不做API授权的控制，建议加上。系统默认自动添加。【限流】：控制此AppKey访问API的限流策略，需关联限流策略。用户手册24/44【IP访问控制】：可以配置黑白名单，需关联IP访问控制策略。在访问控制首页，在限流记录上，点击关联策略，可以选择租户配置的限流策略。在访问控制首页，在IP访问控制记录上，点击关联策略，可以选择租户匹配值的IP访问控制策略。4.4API文档4.4.1功能描述用户手册25/44租户可通过API文档来查询租户发布的API和API详细信息，通过API文档可了解某API的请求地址、请求方式、鉴权参数、请求参数的说明及示例、正确返回的示例、错误返回码、错误返回示例。集成开发人员根据此信息来开发调用。4.4.2业务规则•API查询输入API名称或者地址，模糊查询出符合条件的API列表，点击具体API，可快速定位并打开API详情页面。•API清单选择产品分类、产品和API分类时可以查看下属的所有API清单。•API详情页通过API查询，或者点击左侧树中某个API时，可打开API详情页。•在线测试开放平台提供在线测试API功能，用户根据appkey和appsecret获取token，即可进行调试，并查看调试结果。4.4.3操作说明4.4.3.1API查询进入API文档页面，支持按照原厂和自定义API查询。如下图：用户手册26/44顶部查询条件，输入API名称或者访问地址，回车或点击查询图标按钮，列出所有符合条件的API名称，如下图：点击查询列表中的具体API，则快速定位到此API，并显示此API的详情页，如下图：用户手册27/444.4.3.2API测试工具开放平台提供在线测试API功能，用户输入token，即可进行调试，并查看调试结果。在API详情页，页面顶部或底部，点击按钮，进入API测试工具页面，如下图：用户手册28/44左侧输入参数，点击<开始>发起调试，右侧显示调试结果4.5API路由4.5.1功能描述API路由是指在Web应用程序中定义和管理不同的URL路径（端点），以便将HTTP请求路由到相应的处理程序或控制器函数。它是构建Web服务和API的关键组成部分，可以让客户端应用程序与服务器端进行通信和数据交换。注意：如果一个API实现的集成方案，如果在客户仅实施一个集成方案，无需配置API路由规则。用户手册29/444.5.2业务规则•由于集成平台的路由条件属性仅支持header或query参数，所以在API定义时，需要在入参里手工增加路由条件对应参数，然后在路由配置时一定要选择header或query里的参数，不要选择body里的参数。•需要支持路由的集成方案，领域需要提前规划好支持哪些路由条件属性，领域开发调用集成方案API时，需要将可能的路由条件属性值添加到请求header或query里。4.5.3操作说明API路由配置：管理端提供两个配置入口。第1种路由增加方式，首先在”API发布”查询到相关API，接下来进入API详情，可以看到路由配置页签，点击“新增”增加API路由配置。用户手册30/44管理端提供两个配置入口。第2种路由增加方式，在管理端的菜单，查找到”API路由”，进入”API路由”填写路由名称及描述，完成规则配置。用户手册31/44用户手册32/44第五章安全策略5.1IP访问控制5.1.1功能描述提供IP访问控制策略的配置，策略名称用于标识IP访问控制，策略类型分为黑名单、白名单，黑名单为表示在黑名单内的IP不允许访问，其它IP可以访问，白名单表示只允许白名单内的IP可访问。用户手册33/445.1.2业务规则•支持IP控制策略的添加、编辑、删除、查看，被关联的IP访问控制不能被删除5.1.3栏目说明IP控制策略：字段名称说明策略名称IP访问控制策略名称，必填策略描述IP访问控制策略描述信息，非必填类型黑名单、白名单，必填黑名单表示禁止访问；白名单表示运行访问IP名单支持多个，必填5.1.4操作说明5.1.4.1添加IP访问控制策略为策略命名，选择策略类型，填写策略描述，维护IP名单，操作界面如下：注：配置完成的IP访问控制，使用访问控制插件后，可关联IP访问控制策略。5.2限流控制5.2.1功能描述用户手册34/44提供调用应用基本的限流策略的维护，可维护策略名称、策略描述。支持限流策略控制的配置，配置时间段、数量、维度，即在这个时间段限制最大调用的数量，可针对API、发布方应用、IP、系统、调用方应用等维度。5.2.2业务规则•支持限流策略的添加，支持维护限流策略的具体配置；•支持限流策略的查看、编辑、删除。5.2.3栏目说明限流策略：字段名称说明策略名称限流策略名称，必填策略描述限流策略描述信息，非必填策略级别调用应用，固定限流明细维护时间段、数量、维度，维度包括调用方应用、API、IP支持多个，必填5.2.4操作说明5.2.4.1添加IP访问控制策略为策略命名，选择策略类型，填写策略描述，维护限流明细，操作界面如下：用户手册35/44维度包括调用方应用、API、IP，其中维度若为【调用方应用】表示按整个应用的所有请求不能超过所设限流阈值；若为【API】表示当前应用按每个API的所有请求不能超过所设限流阈值；若为【IP】表示当前应用按每个请求IP的所有请求不能超过所设限流阈值。注：配置完成的限流策略后，使用限流插件时可关联限流策略。第六章事件订阅6.1事件文档6.1.1功能描述租户可通过事件文档来查询发布的事件和事件详细信息，通过事件文档可了解某事件的请事件描述、事件编码、事件字段描述、事件内容示例等信息。集成开发人员根据此信息来开发调用。6.1.2关键应用•事件查询输入事件名称或者事件编码，模糊查询出符合条件的事件列表，点击具体事件，可快速定位并打开事件详情页面。•事件清单选择产品分类、产品和API分类时可以查看下属的所有事件清单。•事件详情页通过事件查询，或者点击左侧树中某个事件时，可打开事件详情页。6.1.3操作说明6.1.3.1事件查询进入事件文档页面，如下图：用户手册36/44顶部查询条件，输入事件名称或者事件编码，回车或点击查询图标按钮，列出所有符合条件的事件名称，如下图：点击查询列表中的具体事件，则快速定位到此事件，并显示此事件的详情页，如下图：用户手册37/446.2事件日志6.2.1功能描述租户可通过事件日志来查询租户定义事件的日志信息6.2.2关键应用•事件日志查询支持根据产品分类、产品、模块、消息ID、事件名称、事件编码、推送结果、推送时间范围进行事件日志查询。•事件日志详情页通过事件日志查询，可打开事件日志详情页。6.2.3字段说明此页面只是事件日志查询功能，无字段说明6.2.4操作说明用户手册38/446.2.4.1事件日志进入事件日志页面，输入相应查询条件，点击查询可以查询到事件日志，如下图：点击查询结果列表中的【日志详情】，打开事件日志详情页，可以查看日志详情，如下图：6.3事件订阅用户手册39/446.3.1功能描述事件订阅功能允许用户针对特定事件设置监听，实现自动化的响应和处理。当预设事件发生时，系统会自动触发预定义的操作或通知，从而提高效率并确保实时响应。这种机制适用于各种场景，如业务流程自动化、实时数据更新通知、或异常事件的即时报警。通过事件订阅，用户可以定制个性化的工作流程，实现数据驱动的决策和即时反馈。这样不仅提高了工作效率，还增强了系统的灵活性和响应能力，使企业能够更快地适应和应对各种业务场景和挑战。6.3.2业务规则•回调地址验证：开放平台使用回调地址来推送事件，该地址需公网可访问。在保存订阅信息时，平台会向此地址发送测试事件以验证其有效性。开发人员可以利用测试按钮推送测试事件，确保地址有效后再订阅具体业务事件。•预警邮箱设置：当事件推送失败时，开放平台将通过预设的预警邮箱通知相关人员，确保及时响应和处理。•限流配置：提供限流选项，允许配置特定时间内的最大推送次数，防止应用后端服务过载。可设置为“0”以取消限流。•重试机制：支持配置推送失败时的重试次数，以增加推送成功率。•订阅流程：用户通过“新增订阅”进入订阅页面，选择所需订阅的事件（支持多选），点击确定即完成事件订阅。6.3.3栏目说明授权key信息字段名称说明授权Key描述授权KEY的描述信息AppKey全局唯一的AppKey标识用户手册40/44AppSecretAppKey对应的密钥信息，可重新生成事件订阅信息字段名称说明回调地址开放平台使用’回调地址’来推送事件通知。这个地址必须是公网可访问的。当保存订阅信息时，为了验证回调地址的有效性，开放平台会向其发送一个测试事件。开发人员在创建事件订阅接口时可以利用测试按钮来发送测试事件。只有在成功接收测试事件后，才能订阅具体的业务事件预警邮箱会计期间：选择进行试算平衡会计年度和会计月，不支持多选，选择当前转账业务发生的会计期间，是转账数据来源的依据。限流策略可配置多少秒内推送的次数，以免将应用后端服务压力过大，0次代表不限流。重试次数可配置推送失败重新发送的次数加密方式AES（高级加密标准）是一种对称加密算法，用于保护电子数据的安全。AES加密具有不同的加密密钥长度（如128位、192位和256位），提供了强大的加密能力，能有效抵御各种已知的攻击方式。事件订阅采取256位的加密密钥长度。订阅的事件列表已订阅的事件列表6.3.4操作说明6.3.4.1.1新增授权KEY进入事件订阅页面，点击左上角的【添加】按钮，弹出维护窗口，填写授权KEY描述，点击【确定】完成添加。授权KEY描述一般为调用方的描述信息，例如：费控系统审批通过信息。操作界面如下：用户手册41/446.3.4.1.2事件订阅为此授权KEY订阅事件，点击【事件订阅】按钮进入事件订阅界面，显示订阅的基本信息和已经订阅的事件。订阅的基本信息包括回调地址、预警邮箱、限流配置和重试次数。回调地址：是开放平台推送事件的地址，需要保证可以在公网访问，在保存订阅信息时，开放平台会向该地址推送测试事件，以验证回调地址的有效性。开发人员在开发事件订阅接口时可使用测试按钮推送测试事件，待测试事件推送成功后，再订阅具体的业务事件。预警邮箱：事件订阅推送失败会向此邮箱发送通知。限流配置：可配置多少秒内推送的次数，以免将应用后端服务压力过大。重试次数：可配置推送失败重新发送的次数。点击【新增订阅】，进入新增订阅页面，选择需要订阅的事件，可多选，点击【确定】完成事件的订阅，在事件订阅页面可删除已订阅的事件。用户手册42/446.4网关设置6.4.1总体概述提供API发布相关配置功能，同时租户可以将内部文档对外进行分享。6.4.2总体价值租户可以在此设置API发布地址的生成规则，也可以将内部接口进行分享。用户手册43/446.4.3相关内容•[系统参数](/detail/yonlinker_systemparameter)。
