Documentation
开发文档
三步完成接入,清晰的接口协议,完善的返回参数
聚合登录介绍
聚合登录,就是利用用户在第三方平台上已有的账号来快速完成自己应用的登录流程。这里的第三方平台,是指 QQ、微信、微博、百度等平台。通过本站的聚合登录接口,你的网站可以登录获取相应的用户信息和授权信息,例如 uid、token、用户昵称、头像等。本站的聚合登录完全符合 OAuth 2.0 身份鉴权机制。
接口协议规则
| 项目 | 说明 |
|---|---|
| 传输方式 | HTTP |
| 数据格式 | JSON |
| 字符编码 | UTF-8 |
聚合登录流程
Step 1
获取跳转登录地址
GET
https://u.zizyw.com/connect.php?act=login&appid={appid}&appkey={appkey}&type={type}&redirect_uri={url}
支持的 type 参数值:
qq QQwx 微信sina 微博baidu 百度douyin 抖音huawei 华为xiaomi 小米dingtalk 钉钉feishu 飞书wework 企业微信gitee Gitee返回示例:
JSON
{
"code": 0,
"msg": "succ",
"type": "qq",
"url": "https://graph.qq.com/oauth2.0/XXXXXXXXXX"
}
返回参数说明:
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
code | int | 返回状态码 | 0 为成功,其它为失败 |
msg | string | 返回信息 | 返回错误时的说明 |
type | string | 登录方式 | |
url | string | 登录跳转地址 | https://graph.qq.com/... |
qrcode | string | 扫码地址 | 仅微信和支付宝返回 |
Step 2
跳转到登录地址
登录地址为上一步返回的 url 的值。引导用户在浏览器中访问该地址进行授权。
Step 3
登录成功,获取 Authorization Code
登录成功后会自动跳转到指定的 redirect_uri,并跟上 Authorization Code。
例如回调地址是 www.example.com/callback,则跳转到:
URL
http://www.example.com/callback?type=qq&code=520DD95263C1CFEA0870FBB66E******
Step 4
通过 Code 获取用户信息
GET
https://u.zizyw.com/connect.php?act=callback&appid={appid}&appkey={appkey}&type={type}&code={code}
返回示例:
JSON
{
"code": 0,
"msg": "succ",
"type": "qq",
"access_token": "89DC9691E274D6B596FFCB8D43368234",
"social_uid": "AD3F5033279C8187CBCBB29235D5F827",
"faceimg": "https://thirdqq.qlogo.cn/...",
"nickname": "大白",
"location": "XXXXX市",
"gender": "男",
"ip": "1.12.3.40"
}
返回参数说明:
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
code | int | 返回状态码 | 0 成功,2 未完成登录 |
msg | string | 返回信息 | 返回错误时的说明 |
type | string | 登录方式 | |
social_uid | string | 第三方 UID | AD3F5033279C8187... |
access_token | string | 第三方 Token | 89DC9691E274D6B5... |
faceimg | string | 用户头像 | https://thirdqq.qlogo.cn/... |
nickname | string | 用户昵称 | 消失的彩虹海 |
gender | string | 用户性别 | 男 |
location | string | 所在地 | XXXXX市(仅支付宝/微信) |
ip | string | 登录 IP | 1.12.3.40 |
获取用户信息接口
在用户登录后的任意时间,可以请求以下接口再次查询用户的详细信息。
GET
https://u.zizyw.com/connect.php?act=query&appid={appid}&appkey={appkey}&type={type}&social_uid={social_uid}
social_uid 就是用户的第三方登录 UID,用于识别用户的唯一字段。
返回示例:
JSON
{
"code": 0,
"msg": "succ",
"type": "qq",
"social_uid": "AD3F5033279C8187CBCBB29235D5F827",
"access_token": "89DC9691E274D6B596FFCB8D43368234",
"nickname": "大白",
"faceimg": "https://thirdqq.qlogo.cn/...",
"location": "XXXXX市",
"gender": "男",
"ip": "1.12.3.40"
}
返回参数说明:
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
code | int | 返回状态码 | 0 为成功 |
msg | string | 返回信息 | 返回错误时的说明 |
type | string | 登录方式 | |
social_uid | string | 第三方 UID | AD3F5033279C8187... |
access_token | string | 第三方 Token | 89DC9691E274D6B5... |
faceimg | string | 用户头像 | https://thirdqq.qlogo.cn/... |
nickname | string | 用户昵称 | 消失的彩虹海 |
gender | string | 用户性别 | 男 |
location | string | 所在地 | XXXXX市 |
ip | string | 登录 IP | 1.12.3.40 |