# 接入说明

勤策系统为了支持将企业外部各个系统(后面统称为第三方)集成到勤策APP菜单中,实现应用之间交互无缝衔接实现统一SSO。本章主要介绍第三方系统在集成到勤策时,如何通过API接入获取授权信息,以及各个API的详细信息。

# 第三方嵌入菜单到勤策系统

这里需要使用oAuth2协议接入鉴权,需要企业管理员和第三方开发者提前做好一些准备操作。

1.申请对接第三方应用APPID,申请第三方应用APPID需要提供应用名称、应用图标、应用信任域名。企业管理员需要联系勤策客成经理操作,申请流程具体步骤详见(申请第三方应用APPID (opens new window)),申请完成后会获取到应用的配置信息:app_id(应用ID), app_secret(应用秘钥), tenant_id(企业ID)

2.创建内嵌到勤策的菜单,管理员需要根据业务要求,需要提供菜单URL,菜单名称,菜单所在目录。注意菜单URL所在域名要和1中申请的应用信任域名一致,如:https://www.yourcompany.com/test.html。

3.第三方服务端需要根据引导获取AccessToken (opens new window),用于取得第三方应用调用勤策的授权令牌。

4.第三方服务端需要根据引导获取用户授权信息 (opens new window),用于第三方应用根据用户信息登录第三方系统。

# 第三方直接在外部唤起勤策页面

这里可以直接使用秘钥加密鉴权,需要企业管理员提前配置好接入信息。

1.申请对接第三方OA秘钥,企业管理员需要在勤策系统企业参数中配置OA秘钥参数。

2.(可选)建立勤策员工和第三方系统之间员工的映射关系,企业管理员需要在员工管理中配置员工对应的第三方ID,如果企业员工是通过员工的OpenAPI (opens new window)创建的,系统会自动建立映射关系,如果直接使用勤策员工ID可以不需要映射。

3.第三方获取勤策登录AccessToken,获取接入AccessToken (opens new window),注意这里获取的AccessToken和上面oAuth2接口中AccessToken是不同的。

4.使用AccessToken唤起勤策电脑端和APP端。

# 关键词

关键词 说明
tenant_id 企业ID,对接的企业唯一标识,企业开户时确定。
region 企业所在数据中心,如:数据中心1区地址:https://cloud.region1.qince.com
app_id 应用ID,用来区分接入的第三方系统是来自哪个系统,每个应用只能有一个可信任域名。
app_secret 应用秘钥,用于服务器生成该企业接入勤策系统的应用唯一的授权访问令牌AccessToken,这个秘钥要注意保存,不可以放前端页面。
access_token 企业应用授权令牌,用于调用授权访问的应用接口
code 用户授权令牌,用户获取用户授权的信息
timestamp 时间戳,是从1970年1月1日(UTC/GMT的午夜)开始所经过的毫秒数,表示一个时间点,用于应用的授权验证。
nonce 随机6-16位字符串,用于生成加签名信息。
msg_signature 签名信息,使用勤策规定签名算法生成的签名信息,用于勤策访问安全校验。服务端接口数据签名生成方法 (opens new window)

# 统一鉴权SSO接入示例

  1. 第三方嵌入菜单到勤策系统示例 oAuth2 SSO 接入示例 (opens new window)
  2. 第三方直接唤起勤策页面示例 秘钥登录示例 (opens new window)