1. 用户授权

通过用户授权码(qzcode)获取当前登录用户的基础信息。qzcode你可以通过入口地址上的qzcode参数获取。

注意

  • 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token, 请参考 获取凭证 接口。
  • qzcode为用户的临时授权码。在每次跳转第三方应用时都会用户授权码(qzcode)在第三方提供的链接上。
    • 例如:第三方的链接为 https://www.example.com 那么访问时附带如下形式参数 https://www.example.com?qzcode=XXX 。第三方可以从链接获取传入的 qzcode
    • qzcode 为临时授权码,即使同一用户在每次访问统一第三方应用时都不相同。qzcode 的有效时间为5分钟,并且为一次性使用,失效后需要重新获取。在获取到qzcode后请尽快使用。

1.1. 基本信息

概况 内容
接口地址 /api/platform/oauth2/authorize
请求方法 GET
请求数据类型 URL参数
响应数据类型 JSON

1.2. 请求数据

1.2.1. 请求头(request-header)

请求头除了默认的参数还需要添加如下请求头参数:

字段 描述
auth-token 接口访问凭据,你可以通过平台下发的appid和secret获取凭据

1.2.2. 请求参数(request-parameter)

字段 是否必传 描述
qzcode 平台用户授权码

参数请求示例:

http://api.example.com/xxx?key=value

1.3. 响应数据

响应数据中 code, message, data 为默认字段,所有字段如下表所示:

字段 类型 是否必填 描述
code number 返回码
message string 返回消息
data object 返回数据
userId string 用户ID
teamId string 团队ID
memberId string 团队成员ID(同一用户在不同团队的成员ID不同)
terminalType number 终端类型。1 = 移动端; 2 = WEB端
projectId string 项目ID。当为项目团队时才返回此字段
enterpriseId string 企业ID。当为企业团队时才返回此字段

响应数据结构如下所示:

{
  "code" : 0,
  "message" : null,
  "data" : {
    "userId": "XXX",
    "teamId": "XXX",
    "memberId": "XXXX",
    "terminalType": 1,
    "projectId" : "XXX",
    "enterpriseId" : "XXX"
  }
}

1.4. 错误码

当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。

© All Rights Reserved            updated 2024-08-23 10:14:55

results matching ""

    No results matching ""