# 设置登录配置
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:weDataSetLoginConfig
设置服务商登录配置
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wedata/wedata_set_login_config?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口仅支持第三方平台使用 component_access_token 自己调用。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 component_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| set_type | number | 是 | 1: 配置反查地址 ; 2:配置关联appid |
| recheck_url | string | 否 | 反查地址,set_type =1时生效,若为空表示删除 |
| associate_appid | array | 否 | 关联appid,set_type=2时生效,若为空表示删除 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
# 4. 注意事项
登录配置分为PC端和小程序端,根据接入方式不同需要配置相应的信息。
# PC端
PC端登录需配置反查地址用于查询用户访问服务商系统的登录态,因此服务商需要提供反查接口,详情可见 文档->3.接入流程->第3步->PC端->登录态反查
# 小程序端
- 小程序端登录需配置跟第三方平台账号的关联小程序,由关联小程序发起跳转请求,关联小程序个数上限为5个
- 注意这里的关联小程序是指服务商自己用来发起跳转we分析的小程序,不是指商家的小程序
- 配置完成后,第三方平台的小程序端可以通过调用“半屏小程序”的能力,将We分析小程序以半屏的形态跳转。详情可见文档->3.接入流程->第3步->小程序端
- 如需代小程序添加半屏小程序可查看接口
# 其他说明
# 登录态反查
描述:此接口由服务商自行提供,根据用户在服务商系统登录的登录态反查用户所属uid和过期时间
地址: ***(服务商提供http请求地址,但请求参数与返回参数需要遵循文档规定)
请求方法:POST application/json
请求参数:
| 参数名 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| user_session | string | 是 | 服务商session,用户访问服务商系统的session |
返回参数:
| 参数名 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| ret | number | 是 | 返回码 |
| err_msg | string | 是 | 返回信息 |
| uid | string | 是 | 用户在服务商系统的唯一标识,可以是手机号、邮箱、员工ID等等 |
| expire_at | number | 是 | 过期时间(unix时间戳,单位秒) |
# 5. 代码示例
# 5.1 配置反查地址
请求示例
{
"set_type": 1,
"recheck_url": "xxxxxxxxx"
}
返回示例
{
"errcode": 0,
"errmsg": "OK",
}
# 5.2 配置关联appid
请求示例
{
"set_type": 2,
"associate_appid": [
"xxxxxxxxx"
]
}
返回示例
{
"errcode": 0,
"errmsg": "OK",
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| -1 | system error | 系统繁忙,此时请开发者稍候再试 |
| 9900004 | 请求参数错误 | 请仔细检查请求参数格式 |
# 7. 适用范围
本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。