用户授权流程

流程概览

  1. 开发者后台 > 安全配置 > 用户授权回调配置中配置回调地址。
  2. 构造授权跳转链接,用户授权后页面重定向至 redirect_uri?code={string}&state={string}
  3. code 获取用户 access_token
  4. 用 access_token 获取用户信息

调用时序

构造授权跳转链接

构造如下链接引导用户授权,授权成功后将重定向至 redirect_uri,并附带 codestate 参数。

⚠️ 第三方企业应用接入 WPS 应用市场时,请使用专用接口:ISV 应用授权接口

请求说明

项目说明
请求地址https://openapi.wps.cn/oauth2/auth
请求方法GET
签名方式
支持应用类型企业自建应用、第三方企业应用、第三方个人应用
权限要求

查询参数

参数类型必填说明
client_idstring应用 APPID
response_typestring固定值 code
redirect_uristring开发者后台配置的授权回调地址(需 URL encode)
scopestring授权权限,多个用英文逗号分隔,如 scope1,scope2,scope3注意传入的scope需要先在 开发者后台 > 权限管理 中勾选并申请开通,否则将会报错 ;如果只需要满足单点场景获取当前用户信息时,只需要申请kso.user_base.read即可,其他场景可以按需申请。
statestring自定义字符串,用于防范 CSRF 攻击携带应用上下文。授权后原样返回。建议使用随机值(如 UUID),回调时校验一致性。

示例

http
GET https://openapi.wps.cn/oauth2/auth?response_type=code&client_id={string}&redirect_uri={string}&scope={scope1,scope2,scope3}&state={string}

响应行为

用户登录

用户授权

📌 code 仅可使用一次,10 分钟内未使用将自动过期。

获取用户 access_token

拿到 code 后,在服务端调用接口换取 access_token。详见获取用户 access_token

⚠️ APPKEY 和 access_token 属高敏感信息,后续所有接口调用(刷新 token、获取用户信息等)必须在服务端完成

刷新用户 access_token

access_token 有效期 2 小时,可通过 refresh_token 调用刷新接口重新获取。

关于 access_token:

关于 refresh_token: