开发文档

聚合登录介绍

聚合登录,就是利用用户在第三方平台上已有的账号来快速完成自己应用的登录流程。这里的第三方平台,是指QQ、微信、微博、百度等平台。通过本站的聚合登录接口,你的网站可以登录获取相应的用户信息和授权信息,例如uid、token、用户昵称、头像等。本站的聚合登录完全符合OAuth2.0身份鉴权机制。

接口协议规则

传输方式:HTTP

数据格式:JSON

字符编码:UTF-8

聚合登录流程
Step1:获取跳转登录地址
请求URL:
http://u.555pan.com/connect.php?act=login&appid={你的appid}&appkey={你的appkey}&type={登录方式}&redirect_uri={返回地址}
其中登录方式对应值:
对应值 登录方式名称
qq QQ
wx 微信
sina 微博
baidu 百度
huawei 华为
gitee Gitee
github GitHub
返回格式:
{
  "code": 0,
  "msg": "succ",
  "type": "qq",
  "url": "https://graph.qq.com/oauth2.0/XXXXXXXXXX"
}
返回参数说明:
参数名 参数类型 参数说明 参数示例
code int 返回状态码 0为成功,其它值为失败
msg string 返回信息 返回错误时的说明
type string 登录方式 qq
url string 登录跳转地址 https://graph.qq.com/oauth2.0/XXXXXXXXXX
qrcode string 登录扫码地址 此地址仅微信和支付宝返回

Step2:跳转到登录地址
登录地址为上一步返回的url的值。

Step3:登录成功会自动跳转到指定的redirect_uri,并跟上Authorization Code
例如回调地址是:www.qq.com/my.php,则会跳转到:
http://www.qq.com/my.php?type=qq&code=520DD95263C1CFEA0870FBB66E******

Step4:通过Authorization Code获取用户信息
请求URL: http://u.555pan.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"
}
返回参数说明:
参数名 参数类型 参数说明 参数示例
code int 返回状态码 0为成功,2为未完成登录,其它值为失败
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
获取用户信息接口
在用户登录后的任意时间,可以请求以下接口再次查询用户的详细信息。

请求URL: http://u.555pan.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版本:1.0

点击下载

成品插件下载
下载地址:https://hack168.lanzouv.com/b070mi6ba 密码:3iyv
备用下载地址: https://pan.quark.cn/s/a446aeaff25f
插件安装方法和文件名参考下面内容:
-------------------------------------
魔方财务系统插件
idcsmart.zip
使用方法:
上传到 /public/plugins/oauth 目录解压,然后在后台【系统】->【第三方登录】配置并开启即可。包含QQ、微信、支付宝、微博、百度5种登录方式。

Discuz!X论坛插件
discuzx_plugins.zip
使用方法:
上传到 /source/plugin 目录解压,然后在后台插件列表就可以看到。包含QQ和微信2种登录方式,兼容DiscuzX 3.2~3.4版本,兼容utf-8、gbk、big5编码。

SWAPIDC插件
swapidc_plugin.zip
使用方法:
上传到 /swap_mac/swap_plugins 目录解压,导入install.sql到数据库,然后在后台插件设置开启。包含QQ、微信、微博、支付宝4种登录方式。


WHMCS插件
whmcs_plugin.zip
使用方法:
直接上传到根目录解压,在后台“插件模块”开启,并配置信息,然后在顶部“插件管理”->“555pan.com聚合登录”,查看模板变量,自行修改模板文件。包含QQ、微信、微博、支付宝4种登录方式。只支持whmcs 8.x版本


WordPress博客插件
wordpress_plugin.zip
使用方法:
上传到 /wp-content/plugins 目录解压,然后在后台插件列表启用即可。包含QQ、微信、支付宝、微博、百度、华为、钉钉、谷歌、微软、Facebook、Twitter登录方式。


Z-Blog博客插件
zblog_laycenter_plugin.zip
使用方法:
需要先安装LayCenter插件,然后上传到 /zb_users/LayCenter 目录解压,没有LayCenter文件夹就新建一个,然后在LayCenter后台应用列表启用即可。包含QQ、微信、支付宝、微博4种登录方式。


zblog_ytuser_plugin.zip
需要先安装YtUser插件,然后上传到 /zb_users/plugin/YtUser 目录解压覆盖,在login.php里面修改接口地址,在后台填写QQ登录的appid和appkey


Emlog博客插件
emlog_plugin.zip
使用方法:
上传到 /content/plugins 目录解压,然后在后台插件列表开启,包含QQ和微信登录方式,由于emlog对于用户权限的控制问题,仅支持管理员或作者账号绑定快捷登录。


Typecho博客插件
typecho_plugin.zip
上传到 /usr/plugins 目录解压,在后台插件列表开启即可,包含QQ、微信、支付宝、微博登录方式。插件开启后需要自行修改模板代码,加入登录按钮代码。


苹果CMSV10插件
clogin_maccms10.zip
上传到根目录解压,在后台“整合登录配置”配置好密钥开启即可。包含QQ和微信登录方式。如果需要改登录接口地址,是在/extend/login/ThinkOauth.php里面。


HYBBS插件
hybbs_plugin.zip
上传到 /Plugin 目录解压,包含QQ、微信登录方式。


XiunoBBS插件
xiunobbs_plugin.zip
上传到 /plugin 目录解压,包含QQ、微信、微博、支付宝4种登录方式。


Eyoucms插件
eyoucms_plugin.zip
上传到根目录解压覆盖,直接替换原有的QQ、微信、微博登录。


Flarum论坛插件
安装命令:composer require cccyun/flarum-clogin-oauth
安装好之后在后台开启,包含QQ、微信、微博登录方式。


FastAdmin插件
fastadmin_addon.zip
打开/vendor/karsonzhang/fastadmin-addons/src/addons/Service.php,把Service::valid($params);这一行注释掉。然后在后台插件管理,点击本地安装。