# 开放平台2.0操作文档

#一、开放平台2.0

1、连接平台------在连接平台引入连接器的概念,通过配置连接器能将数据传输到第三方平台当中,也能实现配置连接器实现薪事力单点登录到第三方系统;

2、API中心------这里有完整的薪事力开发者信息和接口信息,能在这里跳转到详细的API接口文档中,可供第三方平台安全调用,获取到薪事力的数据或写数据到薪事力。可以通过IP白名单,可限制第三方调用薪事力接口。

#二、开放平台2.0和1.0对比 1773818155418.png

# 三、注意事项

1、开放平台2.0受开放平台2.0license控制,需开通license才可使用,并且目前集团版只支持集团下有权限,子单位无法独立使用开放平台2.0。

2、同一个推送事件不能在2.0和1.0上同时配置,同时配置会出现重复推送数据到第三方平台上。

# 四、开放平台2.0操作说明

连接平台

连接平台主要用于配置第三方API接口文档相关信息实现集成需求。当调用第三方接口在薪事力通过事件触发实现数据推送、单点登录等,可以在连接平台下配置实现。连接平台目前主要功能有连接器管理。

连接器管理

1、数据推送

适用场景:

当与第三方系统集成,需要调用第三方API接口进行数据交互时,可以创建一个连接器,在连接器中配置好第三方接口鉴权信息,然后创建推送事件,当对应的薪事力执行某个事件的时候,就会自动触发推送数据到第三方系统当中,例如:添加部门的时候要把部门同步到第三方平台中,可以在这里配置连接器,在连接器中配置部门推送事件,就可以实现同步。

操作流程:

a、创建连接器,填写基础信息和鉴权设置

b、添加推送事件

c、配置推送事件

d、查看执行记录

2、单点登录

使用场景:

当薪事力需要集成第三方系统页面并且需要鉴权,实现在薪事力上单点登录时,可以创建一个连接器,在连接器中配置好鉴权方式,然后在系统设置------门户设置------自定义菜单中,新增菜单,菜单来源选择第三方鉴权,然后选择配置好的连接器,配置好好菜单后则实现单点登录第三方系统页面。

操作流程:

a、创建连接器,填写基础信息和鉴权设置

b、进入系统设置------门户设置------自定义菜单中,新增菜单,菜单来源选择第三方鉴权,选择刚刚创建的连接器。

c、进入菜单当中,点击此自定义菜单查看效果。

API中心

API中心主要规整了薪事力API接口文档相关内容,便于第三方调用薪事力接口实现集成需求,客户可对第三方调用者设置IP白名单,也能随时查看第三方调用薪事力接口的执行记录,更能保证系统安全。API中心主要功能有开发者信息、页面集成、接口管理、调用日志。

开发者信息

使用场景:

当第三方平台需要调取薪事力API接口进行交互前,需要做鉴权认证,只有提供给对方开发者信息才能鉴权认证通过。开发者信息分为默认开发者和自定义开发者。使用自定义开发者功能可以解决如下场景:

a、只允许第三方访问部分接口(例如只允许第三方访问劳动力管理的接口,其他的接口不对外开放)。

b、多个第三方和薪事力做集成时,可以限制每个第三方能访问的接口范围(例如OA系统只允许访问薪事力组织人事接口,财务系统只允许访问薪事力薪酬接口)。

c、限制第三方只允许在特定的网络下才允许访问接口。

操作流程:

默认开发者:

1、默认开发者在IP范围内,能访问系统内所有API接口。

2、默认开发者支持重置密码,如果担心开发者密码已泄露,可以重置开发者密码,开发者密码重置后,原密码将立即失效,所有第三方只能通过最新密码才能继续集成,或者不再使用默认开发者,也可重置开发者密码,密码不再向外提供,来保证系统的安全性。请慎重使用重置密码功能!

自定义开发者: 1、在自定义开发者中,可以创建多个开发者,提供给不同的第三方系统使用,每个开发者信息可根据需求进行不同的设置。 2、注意事项:自定义开发者仅支持企业版、集团B。

详细开发文档:https://www.yuque.com/x-dhr/pg5f7g/awls8duzc7xfikx5

页面集成

使用场景:

当在第三方平台中需要单点登录跳转到薪事力平台或者在第三方平台应用中做薪事力单个页面的集成时,就需要提供接口和页面参数,页面集成中提供了能做集成的每个页面的页面参数,还有集成的接口说明。

操作流程:

集成参数

集成说明

接口信息

使用场景:

当第三方平台需要调用薪事力API接口集成时,可以进入接口管理查看,接口管理中包含了薪事力所有的API接口,可点击查看跳转到详细的接口文档页面。

操作流程:

点击查看可跳转到详细API接口文档。

调用日志

使用场景:

记录了薪事力API接口被调用的情况,记录了具体是哪个接口,请求的是薪事力什么数据,如果不成功可查看异常信息。

操作流程:

# 五、连接器使用举例说明:开放平台2.0配置推送------实现从薪事力实时同步数据到V5

应用场景:从薪事力实时同步数据到V5,首先需要再智多薪插件上开启实时同步,并且配置好相应的映射关系,然后需要到薪事力开放平台配置相应的推送事件,即可实现实时同步数据到V5。

使用说明:以自动推送汇缴清单到V5表单举例。

1、在智多薪插件上开启自动推送并配置映射

2、在薪事力配置推送事件

2.1、进入薪事力开放平台创建连接器

域名:V5服务地址,也就是数据接收方地址

鉴权方式:自定义签名鉴权

请求位置:HTTP Header

Key:third-token

Value:ehr|${TIMESTAMP}

启用连接器

2.2、在连接器中添加推送事件------锁定汇缴清单

事件:汇缴清单-锁定

请求地址(不同的推送请求地址不同):

/seeyon/ehr/ehr2v5DataPush.do?method=receiveData&configKey=socialRemittance_key

所有推送的请求地址详情:

[薪事力开放平台推送V5地址.txt]

3、验证:社保公积金中锁定汇缴清单后,是否自动实时推送到对应的V5表单

注意:薪事力表单数据实时自动推送V5表单:1、连接器上配置事件:表单数据-数据推送;2、对应表单绑定配置了表单数据-数据推送的连接器。

编撰人:chenyl