单点登录链接生成接口

  • 接口:第三方提供
  • Method:POST
  • 数据格式:JSON
  • 接口说明:该接口用于生成sso单点登录的链接,务必注意
    • 不要直接将sessionId放在返回的url中
    • 建议url一次有效,或者设置比较短的有效期,避免登录链接被滥用
  • 调用方说明:云简在收到单点登录请求后,先通过基于员工获取sessionId接口取到该员工的 sessionId,再携带本接口的参数请求第三方;第三方返回 resCode=9998(或 0)时,云简会删除该员工的 sessionId 缓存并重试一次本接口。
  • 文末有版本说明

请求参数

字段名称 字段类型 字段描述 是否必填
destination String 目标页面, 标准值列表 附录15 否
platform String 商旅渠道名称, 标准值列表-附录1 否
equipment String 设备类型, 标准值列表-附录14 否
plat Integer 平台,移动端,h5等, 标准值列表-附录16 否
orderId String 商旅订单号,当destination为order_info时必填 否
documentNum String 云简的申请单号,当destination为approval_info时,必填 否
depCity Integer 出发城市在云简的编号 否
arrCity Integer 到达城市在云简的编号 否
startDate Long 出发日期(酒店为入住日期),云简侧取行程的出发时间,传递13位毫秒时间戳 否
endDate Long 离店日期,只有酒店会有,传递13位毫秒时间戳 否
tripRecommendId String 行程推荐唯一标识 否
userId Integer 云简的用户编号,与userNo同时传递 否
userNo String 对接时的用户key 是
companyId Integer 云简的公司编号 否
account String 公司账户 是
sessionId String 身份验证信息, 获取sessionId接口 是
sign String 加密的sign,加密方式与身份验证一致。空值不传递不参与生成sign。sign的生成说明及示例代码 是

说明:

  • destination 不传时云简按 main(主页)处理。
  • 未传值的参数云简不会放入请求体,也不会参与 sign 的计算。

返回参数

字段名称 字段类型 字段描述 是否必填
resCode Integer 错误码,正确填10000 是
resMsg String 错误描述,正确写success 是
platform String 商旅渠道名称 否
ssoType String 跳转方式, 标准值列表-附录17 是
contentType String 标准值列表-附录18 否
url String 基础地址(form表单提交为提交地址) 是
data json Form表单需要提交的内容 否

说明:platform 云简侧不解析,第三方可不返回。

请求参数示例

{
  "destination": "main",
  "platform": "examplePlatform",
  "equipment": "H5",
  "plat": 1,
  "userNo": "exampleUserNo",
  "userId": 12345,
  "companyId": 38,
  "account": "exampleAccount",
  "sessionId": "exampleSessionId",
  "sign": "exampleSign"
}

返回参数示例

{
  "resCode": 10000,
  "resMsg": "success",
  "ssoType": "url",
  "url": "https://example.com/sso?ticket=xxxxx"
}

版本说明

版本号 编写日期 更改内容
V1.0 2020.02.01 初稿
V1.1 2022.06.01 将userId调整为userNo,companyId调整为account,为后续废弃做准备
V1.2 2026.09.11 按当前实现修正:startDate、endDate 为13位毫秒时间戳;补充实际传递的 userId;platform 调整为非必填(云简侧不解析);补充 destination 默认值与 9998 重试说明;补充请求、返回示例

results matching ""

    No results matching ""