# 用户PC端登录
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:wedata_login
用户PC端登录
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wedata/wedata_login?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:18
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| user_session | string | 是 | 服务商session,用户访问服务商系统的session |
| uid | string | 是 | 用户在服务商系统的唯一标识,可以是手机号、邮箱、员工ID等等 |
| client_ip | string | 是 | 用户的外网ip |
| user_agent | string | 是 | 用户的user_agent |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| base_resp | object | 返回信息 |
| redirect_url | string | We分析登录链接 |
| expire_at | number | 过期时间(unix时间戳,单位秒) |
# Res.base_resp Object Payload
返回信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| ret | number | 返回码 |
| err_msg | string | 返回信息 |
# 4. 注意事项
- 登录前需要先给调用设置权限接口给用户设置权限
- 登录前服务商需先使用设置登录配置接口设置反查地址
# 其他说明
# 特殊错误码
访问获取到的登录链接, 若出现100024错误码,表示此时we分析系统获取到的用户client_ip和user_agent 跟 服务商系统调用api时传入的不一致
# 登录态反查
描述:此接口由服务商自行提供,根据用户在服务商系统登录的登录态反查用户所属uid和过期时间
地址: ***(服务商提供http请求地址,但请求参数与返回参数需要遵循文档规定)
请求方法:POST application/json
请求参数:
| 参数名 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| user_session | string | 是 | 服务商session,用户访问服务商系统的session |
返回参数:
| 参数名 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| ret | number | 是 | 返回码 |
| err_msg | string | 是 | 返回信息 |
| uid | string | 是 | 用户在服务商系统的唯一标识,可以是手机号、邮箱、员工ID等等 |
| expire_at | number | 是 | 过期时间(unix时间戳,单位秒) |
# 5. 代码示例
请求示例
{
"user_session": "session_key",
"uid": "test",
"client_ip": "127.0.0.1",
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36"
}
返回示例
{
"base_resp": {
"ret": 0,
"err_msg": "OK"
},
"redirect_url": "https://wedata.weixin.qq.com/mp2/supplier/login?open_login=1&open_sid=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"expire_at": 1663818592
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| -1 | system error | 系统繁忙,此时请开发者稍候再试 |
| 9900004 | 请求参数错误 | 请仔细检查请求参数格式 |
| 9900016 | 无权限操作 | 1. 权限相关操作时检查商家we分析权限管理员是否关闭了服务商的成员管理权限 2. 设置权限操作时检查商家账号的权限集列表是否包含请求参数中的权限集 3.登录时uid是否有设置权限 |
| 9900018 | 非法session | 请检查session是否正确 |
| 9900019 | session已过期 | 重新生成session |
# 7. 适用范围
本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。