单点登录
请求域名
- https://cloudapi.qiyuesuo.cn(测试环境)
- https://cloudapi.qiyuesuo.com(正式环境)
请求地址
/open/ssogateway
请求方式
GET
请求参数
参数名称 | 是否必须 | 参数类型 | 参数说明 |
---|---|---|---|
ticket | 是 | string | 单点登录请求凭证(UUID),凭证由平台方生成、维护,需保证凭证的仅支持单次验证特性,即完成一次验证即失效 |
pageType | 否 | string | 单点登录指定的目标页面,默认为主页 INDEX_PAGE(“主页”)、SEAL_PAGE(“公司公章页面”)、TEMPLATE_PAGE(“模板页面”)、 CATEGORY_PAGE(“公司业务分类页面”)、ROLE_PAGE(“公司角色权限页面”)、CONTRACT_LIST_PAGE(“合同列表页面”)、 CONTRACT_STATISTICS_PAGE(“公司合同统计页面”)、CONTRACT_INFO_PAGE(“公司基本信息页面”)、ORGANIZE_PAGE(“公司组织架构页面“)、 COMPANY_FEE_PAGE(”公司费用中心“)、CONTRACT_DETAIL_PAGE(”合同签署页面“)。 H5页面仅支持CONTRACT_LIST_PAGE、CONTRACT_DETAIL_PAGE、INDEX_PAGE 以个人身份单点登录时,仅支持指定以上页面说明中,非公司开头的页面 |
companyId | 否 | string | 单点登录指定的公司ID,指定后用户会以指定的公司身份完成登录,登录的用户必须为该公司的员工,若未指定,则以个人身份登录 |
contractId | 否 | string | 合同ID,仅指定CONTRACT_DETAIL_PAGE(”合同签署页面“)时生效 |
signReturnUrl | 否 | string | 签署完成跳转链接,仅指定CONTRACT_DETAIL_PAGE(”合同签署页面“)时生效 |
hideSidebar | 否 | bool | 是否隐藏页面的侧边栏(包含顶栏),默认不隐藏 |
hideSideBarOnly | 否 | bool | 是否隐藏页面的侧边栏(不包含顶栏),默认不隐藏,若传入参数,则以此参数为准,未传值时,以hideSidebar参数为准 |
hideTopBarOnly | 否 | bool | 是否隐藏页面的顶栏,默认不隐藏,若传入参数,则以此参数为准,未传值时,以hideSidebar参数为准 |
hideDraftBtn | 否 | bool | 是否隐藏顶栏的【签发文件】按钮,默认不隐藏,若页面顶栏隐藏,【签发文件】按钮隐藏 |
返回结果:
- 若单点登录成功,则直接重定向至对应指定的目标页面;
- 若单点登录失败,则重定向回平台方配置的登录页面
单点登录失败说明:
如果单点登录失败,契约锁会以以下Query参数作为链接后缀,重定向至平台方配置的登录页面,例如:
https://www.qiyuesuo.com/?code=201&service=https://cloudapi.qiyuesuo.cn/open/ssogateway&companyId=222222222
参数名称 | 参数类型 | 参数说明 |
---|---|---|
code | string | 失败错误码,详细见后说明 |
service | string | 此次失败的单点登录的原请求数据(去除Ticket后) |
失败错误码说明:
错误码 | 错误码说明 |
---|---|
100 | 非平台方请求,Referer 验证失败请求单点登录接口时未指定ticket参数 |
102 | Ticket验证失败,契约锁通过ticket调用平台方提供的CAS验证接口后,未获取到正确的数据 |
201 | 无效的公司ID,指定的companyId 格式不正确,或未匹配到正确的公司 |
202 | 登录用户不为指定公司的员工,请检查登录用户与指定公司之间的关系 |
203 | 不支持的页面操作,在以个人身份进行登陆时,指定了仅公司身份下才可用的目标页面 |
204 | 无效的合同ID,指定的contractId 格式不正确 |