开发文档

全面、详细的技术文档,帮助您快速集成 清噫互联 聚合登录系统

聚合登录介绍

聚合登录,就是利用用户在第三方平台上已有的账号来快速完成自己应用的登录流程。这里的第三方平台,是指QQ、微信、微博、百度等主流社交平台。

通过 清噫互联 的聚合登录接口,您的网站可以快速获取相应用户信息和授权信息,例如uid、access_token、用户昵称、头像等。我们的聚合登录系统完全符合OAuth2.0身份鉴权机制,确保整个流程的安全性和标准化。

主要优势

  • 提升用户体验:用户无需注册新账号,减少记忆负担
  • 提高转化率:降低注册门槛,显著提升用户注册转化率
  • 获取用户画像:获取用户基础信息,丰富用户画像
  • 减少开发成本:一站式解决多平台登录接入问题
  • 持续维护:我们持续维护各平台接口,无需您关注接口变更

接口协议规则

协议类型 说明 备注
传输协议 HTTPS / HTTP 建议生产环境使用HTTPS
请求方式 GET / POST 根据具体接口而定
数据格式 JSON 统一使用JSON格式返回
字符编码 UTF-8 国际通用编码格式
签名机制 MD5 / SHA256 确保请求安全
超时时间 30秒 建议客户端设置超时

聚合登录流程

完整的OAuth2.0授权流程,保障用户数据安全和隐私。

1

获取跳转登录地址

请求URL:

https://connect.qialas.com/connect.php?act=login&appid={你的appid}&appkey={你的appkey}&type={登录方式}&redirect_uri={返回地址}

参数说明:

参数名 必填 说明 示例
appid 您在用户中心创建的应用ID 123456
appkey 您的应用密钥 a1b2c3d4e5f6
type 登录方式(见下方对应表) qq
redirect_uri 登录成功后的回调地址 https://yourdomain.com/callback

返回示例:

{
    "code": 0,
    "msg": "succ",
    "type": "qq",
    "url": "https://graph.qq.com/oauth2.0/XXXXXXXXXX",
    "qrcode": "https://qr.api.cli.im/qr?data=XXXXX"
}
2

引导用户跳转到登录页面

将用户重定向到上一步返回的 url 地址,用户将在第三方平台完成授权。

如果是微信/支付宝等需要扫码登录的平台,还可以使用返回的 qrcode 地址生成二维码供用户扫码。

3

获取授权码

用户授权成功后,将自动跳转到您指定的 redirect_uri,并附带授权码 code

回调示例:

https://yourdomain.com/callback?type=qq&code=520DD95263C1CFEA0870FBB66E******
4

使用授权码换取用户信息

请求URL:

https://connect.qialas.com/connect.php?act=callback&appid={appid}&appkey={appkey}&type={登录方式}&code={code}

返回示例:

{
    "code": 0,
    "msg": "succ",
    "type": "qq",
    "access_token": "89DC9691E274D6B596FFCB8D43368234",
    "social_uid": "AD3F5033279C8187CBCBB29235D5F827",
    "faceimg": "https://thirdqq.qlogo.cn/g?b=oidb&k=3WrWp3peBxlW4MFxDgDJEQ&s=100&t=1596856919",
    "nickname": "大白",
    "location": "XXXXX市",
    "gender": "男",
    "ip": "1.12.3.40"
}

获取用户信息接口

在用户登录后的任意时间,可以请求以下接口再次查询用户的详细信息。

请求说明

请求URL:

https://connect.qialas.com/connect.php?act=query&appid={appid}&appkey={appkey}&type={登录方式}&social_uid={social_uid}

social_uid 是用户的第三方登录UID,用于识别用户的唯一字段,在登录接口返回。

返回示例:

{
    "code": 0,
    "msg": "succ",
    "type": "qq",
    "social_uid": "AD3F5033279C8187CBCBB29235D5F827",
    "access_token": "89DC9691E274D6B596FFCB8D43368234",
    "nickname": "大白",
    "faceimg": "https://thirdqq.qlogo.cn/g?b=oidb&k=ianyRGEnPZlMV2aQvvzg2uA&s=100&t=1599703185",
    "location": "XXXXX市",
    "gender": "男",
    "ip": "1.12.3.40"
}

返回参数说明:

参数名 类型 说明 示例
code int 返回状态码 0为成功,其它值为失败
msg string 返回信息 返回错误时的说明
type string 登录方式 qq
social_uid string 第三方登录UID AD3F5033279C8187CBCBB29235D5F827
access_token string 第三方登录token 89DC9691E274D6B596FFCB8D43368234
faceimg string 用户头像 https://thirdqq.qlogo.cn/g?...
nickname string 用户昵称 消失的彩虹海
gender string 用户性别
location string 用户所在地 XXXXX市(仅限支付宝/微信返回)
ip string 用户登录IP 1.12.3.40

SDK下载

为方便开发者快速集成,我们提供了多种语言的SDK封装。

SDK完整包 v1.0

包含PHP、Java、Python、Node.js等多种语言实现

下载SDK (ZIP)

SDK包含内容

  • PHP SDK:适用于PHP 7.1+,支持Composer安装
  • Java SDK:适用于Java 8+,支持Maven/Gradle
  • Python SDK:适用于Python 3.6+,支持pip安装
  • Node.js SDK:适用于Node.js 12+,支持npm安装
  • C# SDK:适用于.NET Core 3.1+
  • 示例代码:各语言完整示例
  • 测试工具:接口测试脚本

平台对应表

支持的第三方平台及对应的type值。

type值 登录平台 支持版本 是否需要申请
qq QQ 完整支持 无需申请
wx 微信 完整支持 需要申请
alipay 支付宝 完整支持 需要申请
douyin 抖音 完整支持 无需申请
xiaomi 小米 完整支持 无需申请
wework 企业微信 完整支持 无需申请
gitee Gitee 完整支持 无需申请

注意事项

  • 微信和支付宝需要开发者自行申请对应的AppKey和AppSecret
  • QQ、微博、百度等平台我们已统一申请,可直接使用
  • 所有接口返回数据格式保持一致,便于统一处理
  • 建议在开发环境使用测试模式,生产环境切换为正式模式