销售易 OAuth 集成
# 应用简介
【Neocrm 销售易】融合新型互联网技术的企业级 CRM 服务商,基于AI、大数据、物联网等新 型互联网技术，打造企业级营销服一体化CRM，将企业同客户互动的全过程数字化、智能化，帮助企业转型为真正以客户为中心的数字化运营组织，实现业绩的可持续增长。销售易已连续 6 年入选 Gartner SFA 全球魔力象限。
# 文档说明
此文档主要说明销售易（客户端）如何通过 OAuth2 协议和竹云IDaaS（服务端）集成。
销售易除了支持 OAuth 集成外，目前还支持 SAML2.0 集成单点登录，如果销售易内同时管理 CRM 和 PRM 用户，通过 OAuth 协议集成后，可以实现PRM 登出时跳转到服务端的登录界面，如果没上述需求，建议采用 SAML集成，相对来配置简单一些。
# 前提条件
- 具备销售易租户环境
- 具备竹云 IDaaS 租户环境
- 具备上述两个环境的超级管理员账号
# 集成步骤概述
- 竹云 IDaaS 注册应用（认证协议选择：OAuth）
- 销售易新增认证连接器。类型为：oauth 认证连接器
- 销售易根据竹云 IDaaS注册应用提供的相关参数进行配置
- 匹配关联账号
- 测试登录验证
# 详细集成步骤
# IDaaS注册应用
进入竹云IDaaS企业中心，添加销售易应用
获取【ClientId】和【ClientSecret】参数，记录备用
# 创建销售易认证连接器
进入销售易后台设置界面
根据竹云 IDaaS 中获取【ClientId】和【ClientSecret】参数进行填写
# 销售易认证连接器配置
进入销售易认证连接器配置界面
# 自定义参数配置
配置如下参数：
| 参数名称 | 参数API Key | 初始值 |
|---|---|---|
| response_type | response_type | "code" |
| state | state | "state" |
| grant_type | grant_type | "authorization_code" |
示例如下：
# Auth code配置
基本信息
Request URL：https://{租户域名地址，示例：域名：xx.xxx.com}/api/v1/oauth2/authorize
请求方式：get
SP Request 阶段参数配置
| 存放位置 | 变量名称 | 变量值（只能选择） | 变量值类型 |
|---|---|---|---|
| Request Body | redirect_uri | redirect_uri | SP 参数 |
| Request Body | client_id | client_id | IDP 参数 |
| Request Body | state | state | 自定义参数 |
| Request Body | response_type | response_type | 自定义参数 |
示例如下：
IDP RESPONSE阶段参数配置
| 参数名称 | 参数值来源变量 |
|---|---|
| auth_code | code |
示例如下 ：
# Access Toekn配置
基本信息
Request URL：https://{租户域名地址，示例：域名：xx.xxx.com}/api/v1/oauth2/token
请求方式：post
SP Request 阶段参数配置
| 存放位置 | 变量名称 | 变量值（只能选择） | 变量值类型 |
|---|---|---|---|
| Request Body | grant_type | grant_type | 自定义参数 |
| Request Body | client_secret | client_secret | IDP 参数 |
| Request Body | client_id | client_id | IDP 参数 |
| Request Body | code | auth_code | 系统参数 |
示例如下：
IDP RESPONSE阶段参数配置
| 参数名称 | 参数值来源变量 |
|---|---|
| access_token | access_token |
示例如下：
# Identity Federation配置
基本信息
Request URL：https://{租户域名地址，示例：域名：xx.xxx.com}/api/v1/oauth2/userinfo
请求方式：get
SP Request 阶段参数配置
| 存放位置 | 变量名称 | 变量值（只能选择） | 变量值类型 |
|---|---|---|---|
| Request Body | access_token | access_token | 系统参数 |
| Request Body | client_id | client_id | IDP 参数 |
示例如下：
IDP RESPONSE 阶段参数配置
| 参数名称 | 参数值来源变量 |
|---|---|
| identify_federation | userName |
示例如下：
# Logout Settings配置（可选）
基本信息
RequestURL：https://{租户域名地址，示例：域名：xx.xxx.com}/api/v1/logout
请求方式：get
SP Request 阶段参数配置
| 存放位置 | 变量名称 | 变量值（只能选择） | 变量值类型 |
|---|---|---|---|
| Request Body | redirect_url | logout_url | SP 参数 |
| Request Body | client_id | client_id | IDP 参数 |
示例如下：
# 测试验证
# 开启第三方认证
# 建立关联匹配账号
销售易人员和竹云 IDaaS人员在单点登录时，依赖的销售易人员中的【唯一标识】属性字段和竹云用户的【用户名/其他唯一属性】进行的匹配登录，故验证前先手动维护销售易的上述字段。
# 登录访问
访问销售易登录首页
选择【竹云】方式登录
- 输入竹云账号名密码，点击确定
- 查看登录结果。
# 附录
[销售易官网针对OAuth协议集成说明](https://doc.xiaoshouyi.com/?code=8U1tuG0#/proMan/workplaceDetail?url=%2F%2Ftas ks%2F%E9%94%80%E5%94%AE%E6%98%93CRM_PaaS%E5%B9%B3%E5%8F%B0_% E7%B3%BB%E7%BB%9F%E5%8D%95%E7%82%B9%E7%99%BB%E5%BD%95%E9% 85%8D%E7%BD%AE_V2108.01_%E7%BB%91%E5%AE%9A_sp_%E4%B8%8E_idp_%E7 %94%A8%E6%88%B7.html&id=802&dir=output_1654767381620&time=169701647076 0&proId=undefined&checkStat=undefined)