企业实现单点登陆·一洽客服系统

目录

1. 需求场景
2. SSO登录

1.需求场景

在接入一洽客服系统之前,企业已经存在了很多自己的业务系统,比如:OA系统、工单系统、财务系统等,在企业员工需要使用一洽客服系统处理业务时,需记住或者保存下登陆一洽客服系统的账号密码,便于使用,此时企业可通过此接口实现利用企业现有的SSO登陆系统或者某个常用系统(OA)的账号直接跳转登录至一洽客服系统。

接入统一登陆之前:

接入统一登陆之后:

1.SSO登录

企业开发者可通过此接口将一洽客服平台集成至已有的企业系统内,通过客服已有的账号进行快速登入。

登入流程

接口地址

http请求方式: GET

 https://${apiServer}/ssoLogin/${appId}?accessToken=${accessToken}

参数说明

参数 是否必须 说明
accessToken 接口调用凭证
staffMetaData 当前登录的客服账号信息。

staffMetaData生成规则

1.将需要登陆一洽平台的客服信息按照要求组装成JSON字符串
2.通过AES加密的方式对JSON字符串进行加密。详细请查看[AES加解密说明](aesCrypt.html)

staffMetaData Json 属性介绍:

1.staffName,staffPhoto,chatName,chatPhoto 在首次客服登录,创建一洽身份时有效,在多次登录过程中修改此值系统不会自动更新,请在一洽客服平台内修改客服信息。
2.在客服首次登录后,请联系管理员设置会话相关配置(对外头像、对外信息、参与分配情况、所在分组等),设置后才可正常使用一洽平台。
3.sso登录的客服角色默认为ssologin的角色。
字段 类型 长度限制 是否必须 说明
staffName String 50 当前登录客服在客服平台显示的客服名字,在首次创建客服时有效。如果多次登录时staffName有变化,系统不会自动更新,请在一洽客服平台内修改客服信息。
staffPhoto String 255 当前登录客服的客服头像,在首次创建客服时有效。如果多次登录时staffPhoto有变化,系统不会自动更新,请在一洽客服个人中心修改
chatName String 50 当前登录客服在客服平台的对话服务昵称,在首次创建客服时有效。如果多次登录时chatName有变化,系统不会自动更新,请在一洽客服平台内修改客服信息。
chatPhoto String 255 当前登录客服在客服平台显示的对话服务头像,在首次创建客服时有效。如果多次登录时chatPhoto有变化,系统不会自动更新,请在一洽客服平台内修改客服信息。
loginName String 50 标识当前客服身份的唯一账号
loginStatus int 4 当前登录客服的登录状态。 1:在线 2:满足 3:离开 4:隐身
lan String 255 登陆语种:zh、zh-TW、en、ja
companyId int 4 多商户必传:商户ID
redirectUrl String 255 指定跳转页面
{
    "staffName":"一洽客服",
    "staffPhoto":"https://www.echatsoft.com/images/logo/icon_echat_logo_1.png",
    "chatName":"echatsoft",
    "chatPhoto":"https://www.echatsoft.com/images/logo/icon_echat_logo_1.png",
    "loginName":"13188888888",
    "loginStatus":1,
    "lan":"zh",
    "companyId":88,
    "redirectUrl":"http://e.echatsoft.com/staff-v2/zh-cn/main.html"
}

加密后:(在线加密工具)

staffMetaData=v/BygBsskpTWlVY93IlxuhkLhZBMxQZOUIzNCf7DxwMXXZSMZfO5/XA4IXeARTwFWy9j7lyUvrbfsSnoWO7QQQhSfsBB3IXZIlI7NenL7k9wNn2zD4axZmFR41wxJVITMYEeafQDD1sDfA0aEBIR4Byf6omWZsGJe5yU51NpPto=
		

返回说明

1.登录成功后会跳转至客服工作台页面
2.如登陆失败,会返回错误信息的json数据
	

错误示例:


{"errcode":104,"errmsg":"accessToken错误"}