FactVerse 与第三方平台单点登录(SSO)API 接入说明

你在这里:
< 所有主题

接口概述

接口用途

本接口用于实现第三方平台与 FactVerse系统的单点登录集成,第三方平台通过SSO 认证后,可通过本接口获取 FactVerse系统的访问令牌,进而实现系统间无缝登录访问。

适用场景

第三方平台需与 FactVerse系统进行用户身份互通,无需用户重复登录,直接通过第三方平台已认证的身份获取 FactVerse系统访问权限的场景。

前置条件

  1. 第三方平台已完成开放平台的能力,支持 Oauth2.0 协议;
  2. 第三方平台已 FactVerse 系统完成备案,获取合法的来源标识(from 参数值);
  3. 调用方已明确知晓接口请求参数格式、响应规则及错误处理机制。

接口详情

基本信息

项目

内容

接口名称

第三方单点登录回调接口

请求方法

GET

接口地址

/api/v6/oauth2/{type}/callback

支持格式

JSON

响应类型

JSON

请求参数

路径参数

参数名

类型

是否必填

说明

type

String

登录类型,需联系DataMesh提前备案

查询参数

参数名

类型

必填

说明

取值示例

from

String

来源标识,用于区分第三方平台(需提前备案)

access_token

String

第三方平台分配的访问令牌

请求示例

curl 示例

Curl -X GET “https://{domain}/api/v6/oauth2/{type}/callback?from={from}&access_token={access_token}”

请求 URL 示例

https://{domain}/api/v6/oauth2/{type}/callback?from={from}&access_token={access_token}”

响应说明

响应格式

接口响应统一采用 JSON 格式,包含状态码、提示信息及业务数据(成功时返回)。

成功响应

响应状态码:200 OK

响应示例:

json

{

  “code”: 0,

  “message”: “成功”,

  “data”: {

    “accessToken”: “eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…”,

    “refreshToken”: “eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…”

  }

}

成功响应字段说明:

字段名

类型

说明

取值示例

code

Integer

响应状态码,0 表示成功

0

message

String

响应提示信息

成功

data

Object

业务数据对象,仅成功时返回

data.accessToken

String

FactVerse系统访问令牌,后续请求需携带此令牌

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…

data.refreshToken

String

令牌刷新凭证,用于在 accessToken 过期后获取新令牌

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…

错误响应

响应状态码:非 200(如 400 Bad Request、500 Internal Server Error 等,结合错误类型匹配)

响应示例:

json

{

  “code”: “10400001”,

  “message”: “参数错误”,

  “description”: “请求参数不完整或格式错误”

}

错误码说明:

错误码

错误信息

详细描述

触发条件

解决方案

10400001

参数错误

请求参数不完整或格式错误

from 或 access_token 参数为空、格式不符合要求

检查并补充必填参数,确保参数格式与文档要求一致

10500012

第三方认证失败

第三方开放平台认证失败

access_token 已过期、无效或认证过程出现异常

从第三方开放平台获取合法有效的 access_token 后重试

10500013

用户不存在

用户在FactVerse系统中不存在

第三方开放平台的用户未在 FactVerse系统匹配到对应用户

确认用户已在 FactVerse系统完成注册,或联系DataMesh 管理员处理用户信息同步问题

接口调用流程

流程图

关键说明

跳转回调时需确保参数传递完整,避免丢失 from 或 access_token;

access_token 需在有效期内使用,过期后需重新从第三方平台获取;

后续所有请求FactVerse系统接口时,需在 HTTP 请求头中携带 Authorization: Bearer {accessToken},否则将被拒绝访问。

注意事项

  1. 接口调用需保证网络通畅,避免因网络超时、断连导致请求失败;
  2. accessToken 和 refreshToken 属于敏感信息,需通过 HTTPS 协议传输,且在存储时需加密,避免泄露;
  3. refreshToken 具有有效期,建议在 accessToken 过期前 30 分钟内使用 refreshToken 调用令牌刷新接口(需单独对接)获取新令牌;
  4. 若 1 小时内连续出现 5 次及以上认证失败错误,该第三方平台的调用权限可能被临时冻结,需联系管理员解冻;

联系方式

若在接口对接过程中遇到问题,可通过以下方式咨询:

技术支持邮箱:support@datamesh.com

目录