更新2.1.0版本文档
This commit is contained in:
parent
9cec7f0fdf
commit
588986fe55
27
README.md
27
README.md
|
|
@ -1,21 +1,34 @@
|
||||||
# QuickAuth
|
# QuickAuth
|
||||||
|
|
||||||
#### 介绍
|
## 介绍
|
||||||
|
|
||||||
QuickAuth是一个免费、便捷的第三发登录平台
|
QuickAuth是一个免费、便捷的第三发登录平台
|
||||||
|
|
||||||
#### 支持的第三方登录
|
该仓库为QuickAuth的文档站
|
||||||
|
|
||||||
- 微信
|
## 支持的第三方登录平台
|
||||||
|
|
||||||
|
- 微信（H5、开放平台、小程序）
|
||||||
|
- 短信验证码
|
||||||
- QQ
|
- QQ
|
||||||
- Github
|
- Github
|
||||||
- Gitee
|
- Gitee
|
||||||
|
- 支付宝
|
||||||
|
- 微博
|
||||||
|
- 钉钉
|
||||||
|
|
||||||
#### 软件特点
|
## 软件特点
|
||||||
|
|
||||||
1. 简单易用，接口文档清晰完善，并提供Typecho WordPress插件
|
1. 简单易用，接口文档清晰完善，并提供Typecho WordPress插件
|
||||||
2. 接入免费，个人可免费接入，不需要企业资质，不需要进行微信认证
|
2. 接入免费，个人可免费接入，不需要企业资质，不需要进行微信认证
|
||||||
3. 支持定制，微信登录可自定义小程序图标，可自定义扫码登录页面（待完善）
|
3. 支持定制，微信登录可自定义小程序图标，可自定义扫码登录页面等
|
||||||
|
|
||||||
#### 使用说明
|
## 相关链接
|
||||||
|
|
||||||
请参考 [接入文档](https://wixy.gitee.io/qauth-doc)
|
- WordPress接入插件 [QualPro](https://github.com/mr-wixy/QualPro)
|
||||||
|
- Typecho接入插件 [QuickAuthLogin](https://github.com/mr-wixy/QuickAuthLogin)
|
||||||
|
- WordPress接入插件 [QuickAuthLogin-WP](https://github.com/mr-wixy/QuickAuthLogin-WP)
|
||||||
|
|
||||||
|
## 使用说明
|
||||||
|
|
||||||
|
请参考 [接入文档](https://mr-wixy.github.io/qauth-doc)
|
||||||
|
|
|
||||||
|
|
@ -1,42 +1,40 @@
|
||||||
## QuickAuth介绍
|
# QuickAuth介绍
|
||||||
|
|
||||||
> QuickAuth是一个便捷的第三方登录集成平台，支持微信（开放平台、服务号、小程序）、QQ、Github、Gitee等多平台授权登录方式，支持通过Typecho、WordPress插件实现免代码接入
|
> QuickAuth是一个便捷的第三方登录集成平台，支持微信（开放平台、服务号、小程序）、QQ、短信验证码、Github、Gitee、支付宝、微博、钉钉等多平台授权登录方式，支持通过Typecho、WordPress插件实现免代码接入
|
||||||
|
|
||||||
### 接入指南
|
## 接入指南
|
||||||
|
|
||||||
- [接入指南](guide/)
|
- [接入指南](guide/)
|
||||||
|
- [推广奖励说明](invite)
|
||||||
- [订阅功能说明](subscribe)
|
- [订阅功能说明](subscribe)
|
||||||
|
|
||||||
### 接口列表
|
## 接口列表
|
||||||
|
|
||||||
#### 普通接口（免费用户可用）
|
### 接口
|
||||||
|
|
||||||
1. [小程序扫码登录界面(/qrconnect)](/guide/method1/qrconnect)
|
1. [授权登录界面(/oauth)](/guide/oauth)
|
||||||
2. [获取用户信息(/user)](/guide/method1/user)
|
2. [获取用户授权信息（/user接口的升级版）(/authinfo)](/guide/authinfo)
|
||||||
|
|
||||||
#### 高级接口（订阅会员可用）
|
### 归档接口（可用但停止更新）
|
||||||
|
|
||||||
1. [授权登录界面(/oauth)](/guide/advanced/oauth)
|
1. [小程序扫码登录界面(/qrconnect)](/guide/archived/qrconnect)
|
||||||
2. [获取用户信息(/user)](/guide/advanced/user)
|
2. [获取用户信息(/user)](/guide/archived/user)
|
||||||
|
3. [获取二维码(/qrcode)](/guide/archived/qrcode)
|
||||||
|
4. [获取扫码状态(/qrcode/state)](/guide/archived/state)
|
||||||
|
5. [用户信息解密(/decrypt)](/guide/archived/decrypt)
|
||||||
|
|
||||||
#### 即将停止维护的接口
|
## 接入应用
|
||||||
|
|
||||||
1. [获取二维码(/qrcode)](/guide/archived/qrcode)
|
|
||||||
2. [获取扫码状态(/qrcode/state)](/guide/archived/state)
|
|
||||||
3. [用户信息解密(/decrypt)](/guide/archived/decrypt)
|
|
||||||
|
|
||||||
### 接入应用
|
|
||||||
|
|
||||||
- [QuickAuth](https://qauth.cn) （QuickAuth项目网站）
|
- [QuickAuth](https://qauth.cn) （QuickAuth项目网站）
|
||||||
- [UltronBlog](https://blog.wixy.cn) （wixy的个人博客）
|
- [UltronBlog](https://blog.wixy.cn) （wixy的个人博客）
|
||||||
- [SiliSchedule](https://sc.wixy.cn) （HTTP定时任务管理系统）
|
- [SiliSchedule](https://sc.wixy.cn) （HTTP定时任务管理系统）
|
||||||
- [更多接入应用](https://qauth.cn/home)
|
- [更多接入应用](https://qauth.cn/home)
|
||||||
|
|
||||||
|
## 相关插件
|
||||||
|
|
||||||
### 相关插件
|
- [QualPro](https://github.com/mr-wixy/QualPro) （WordPress集成登录插件）
|
||||||
|
- [QuickAuthLogin](https://github.com/mr-wixy/QuickAuthLogin) （Typecho博客微信扫码登录插件）
|
||||||
- [QuickAuthLogin](https://gitee.com/wixy/QuickAuthLogin) （Typecho博客微信扫码登录插件）
|
- [QuickAuthLogin-WP](https://github.com/mr-wixy/QuickAuthLogin-WP) （WordPress微信扫码登录插件）
|
||||||
- [QuickAuthLogin-WP](https://gitee.com/wixy/QuickAuthLogin-WP) （WordPress微信扫码登录插件）
|
|
||||||
|
|
||||||
### 其他
|
### 其他
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,18 +1,18 @@
|
||||||
* [文档首页](/)
|
* [文档首页](/)
|
||||||
* [订阅会员功能说明](subscribe)
|
* [推广奖励说明](invite)
|
||||||
* [接入指南](guide/)
|
* [订阅功能说明](subscribe)
|
||||||
* [基础接口（免费）](guide/free/)
|
* [接入指南](/guide/)
|
||||||
* [调用扫码界面](guide/free/qrconnect)
|
* [基础方式](/guide/guide)
|
||||||
* [获取用户信息](guide/free/user)
|
* [登录授权界面](/guide/oauth)
|
||||||
* [高级接口（订阅）](guide/advanced/)
|
* [获取用户授权信息](/guide/authinfo)
|
||||||
* [登录授权界面](guide/advanced/oauth)
|
* [归档接口](/guide/archived/)
|
||||||
* [获取用户信息](guide/advanced/user)
|
* [小程序扫码登录界面](/guide/archived/qrconnect)
|
||||||
* [即将停止维护的接口](guide/archived/)
|
* [获取用户信息](/guide/archived/user)
|
||||||
* [获取二维码](guide/archived/qrcode)
|
* [获取小程序二维码](/guide/archived/qrcode)
|
||||||
* [扫码状态](guide/archived/state)
|
* [获取扫码状态](/guide/archived/state)
|
||||||
* [用户信息解密](guide/archived/decrypt)
|
* [用户信息解密](/guide/archived/decrypt)
|
||||||
* [其他](other/)
|
* [其他](other/)
|
||||||
* [信息的加解密](other/encrypt)
|
* [信息的加解密](/other/encrypt)
|
||||||
* [接入应用及插件](other/apps)
|
* [接入应用及插件](/other/apps)
|
||||||
* [更新历史](other/update)
|
* [更新历史](/other/update)
|
||||||
* [开发计划](other/plan)
|
* [开发计划](/other/plan)
|
||||||
|
|
|
||||||
|
|
@ -1,39 +1,26 @@
|
||||||
# 接入指南
|
# 接入指南
|
||||||
|
|
||||||
|
## 普通接入方式
|
||||||
|
|
||||||
## #微信小程序扫码登陆
|
> 通过跳转界面实现用户授权登录
|
||||||
|
|
||||||
> 通过微信扫码打开小程序完成授权登录的操作
|
### 特点
|
||||||
|
|
||||||
#### 特点
|
- 支持小程序扫码、QQ、Gitee、Github、支付宝、微博、钉钉等永久免费的接入方式
|
||||||
|
- 支持订阅会员专属的 微信扫码登录、SMS短信登录的方式
|
||||||
|
- 支持Typecho和WordPress插件接入，无代码接入
|
||||||
|
|
||||||
- 接入永久免费
|
### 接口列表
|
||||||
- 接入流程简单快捷
|
|
||||||
- Typecho和WordPress可以直接使用插件，无代码接入
|
|
||||||
|
|
||||||
[详细接口文档](/guide/free/)
|
[详细接口文档](/guide/guide)
|
||||||
|
|
||||||
[Typecho接入教程](https://gitee.com/wixy/QuickAuthLogin)
|
[QualPro插件接入](https://github.com/mr-wixy/QualPro)
|
||||||
|
|
||||||
[WordPress接入教程](https://gitee.com/wixy/QuickAuthLogin-WP)
|
[Typecho接入教程（QuickAuthLogin）](https://github.com/mr-wixy/QuickAuthLogin)
|
||||||
|
|
||||||
## #高级订阅接口接入
|
[WordPress接入教程（QuickAuthLogin-WP）](https://github.com/mr-wixy/QuickAuthLogin-WP)
|
||||||
|
|
||||||
> 通过微信扫码打开H5页面完成授权登录的操作，支持微信内静默授权，支持QQ、Github、Gitee等授权登录方式
|
## 复杂接入方式（已归档，停止更新）
|
||||||
|
|
||||||
#### 特点
|
|
||||||
|
|
||||||
- 微信H5授权无需打开小程序，直接完成授权
|
|
||||||
- 支持微信客户端内实现无感登录
|
|
||||||
- 支持QQ、Github、Gitee等授权登录方式
|
|
||||||
|
|
||||||
[详细接口文档](/guide/advanced/)
|
|
||||||
|
|
||||||
[Typecho接入教程（高级版插件正在开发中）](https://gitee.com/wixy/QuickAuthLogin)
|
|
||||||
|
|
||||||
[WordPress接入教程（高级版插件正在开发中）](https://gitee.com/wixy/QuickAuthLogin-WP)
|
|
||||||
|
|
||||||
## #复杂授权方式
|
|
||||||
|
|
||||||
> 开发者通过接口获取二维码并展示，用户扫码授权完成后QuickAuth向开发者配置的回调地址发起授权请求并传入用户信息，开发者根据调用参数和回传参数识别用户登录情况
|
> 开发者通过接口获取二维码并展示，用户扫码授权完成后QuickAuth向开发者配置的回调地址发起授权请求并传入用户信息，开发者根据调用参数和回传参数识别用户登录情况
|
||||||
|
|
||||||
|
|
@ -41,5 +28,6 @@
|
||||||
|
|
||||||
- 可自行获取二维码，自定义登录界面及流程
|
- 可自行获取二维码，自定义登录界面及流程
|
||||||
- 自定义程度高
|
- 自定义程度高
|
||||||
|
- 仅支持小程序扫码登录的接入方式
|
||||||
|
|
||||||
[详细接口文档](/guide/archived/)
|
[详细接口文档](/guide/archived/)
|
||||||
|
|
@ -1,28 +0,0 @@
|
||||||
## #高级接口（订阅会员可用）
|
|
||||||
|
|
||||||
> 高级接口主要包括微信扫码登录、微信客户端内静默授权登录、QQ等其他登录方式、高级统计接口等，仅订阅会员可用
|
|
||||||
|
|
||||||
### 接口列表
|
|
||||||
|
|
||||||
1. [登录授权界面(/oauth)](/guide/advanced/oauth)
|
|
||||||
2. [获取用户信息(/user)](/guide/advanced/user)
|
|
||||||
|
|
||||||
#### 创建应用
|
|
||||||
|
|
||||||
1、登录[quickauth](https://qauth.cn)网站并创建[接入应用](https://qauth.cn/app)
|
|
||||||
|
|
||||||
2、填写详细信息和回调地址并发布应用
|
|
||||||
|
|
||||||
3、记住`AppKey`
|
|
||||||
|
|
||||||
#### 获取解密密钥
|
|
||||||
|
|
||||||
进入[用户中心](https://qauth.cn/config/secret)获取`UserSecretKey`
|
|
||||||
|
|
||||||
#### 修改现有项目
|
|
||||||
|
|
||||||
1、修改自己项目的登录逻辑，携带参数type、appkey和state跳转到[登录授权界面](/guide/advanced/oauth)
|
|
||||||
|
|
||||||
2、用户扫码并授权后界面跳转到应用配置的回调地址并带上参数`code`和`state`
|
|
||||||
|
|
||||||
3、开发者使用code、Appkey、UserSecretKey发起[获取用户信息](/guide/advanced/user)请求并根据返回信息完成登录逻辑
|
|
||||||
|
|
@ -1,25 +1,25 @@
|
||||||
## #即将停止维护的接口
|
# 复杂接入方式（已归档，停止更新）
|
||||||
|
|
||||||
> 开发者通过接口获取二维码并展示，用户扫码授权完成后QuickAuth向开发者配置的回调地址发起授权请求并传入用户信息，开发者根据调用参数和回传参数识别用户登录情况（此接入方式适用范围较窄，目前可以正常调用，后期不排除会停止维护）
|
> 开发者通过接口获取二维码并展示，用户扫码授权完成后QuickAuth向开发者配置的回调地址发起授权请求并传入用户信息，开发者根据调用参数和回传参数识别用户登录情况（此接入方式适用范围较窄，目前可以正常调用，后期不排除会停止维护）
|
||||||
|
|
||||||
### 接口列表
|
## 接口列表
|
||||||
|
|
||||||
1. [获取二维码(/qrcode)](/guide/archived/qrcode)
|
1. [获取二维码(/qrcode)](/guide/archived/qrcode)
|
||||||
2. [获取扫码状态(/qrcode/state)](/guide/archived/state)
|
2. [获取扫码状态(/qrcode/state)](/guide/archived/state)
|
||||||
3. [用户信息解密(/decrypt)](/guide/archived/decrypt)
|
3. [用户信息解密(/decrypt)](/guide/archived/decrypt)
|
||||||
|
|
||||||
|
|
||||||
#### 创建应用
|
## 创建应用
|
||||||
|
|
||||||
1. 登录[quickauth](https://qauth.cn)网站并创建[接入应用](https://qauth.cn/app)
|
1. 登录[quickauth](https://qauth.cn)网站并创建[接入应用](https://qauth.cn/app)
|
||||||
2. 填写详细信息和回调地址并发布应用
|
2. 填写详细信息和回调地址并发布应用
|
||||||
3. 记住`AppKey`
|
3. 记住`AppKey`
|
||||||
|
|
||||||
#### 获取解密密钥
|
## 获取解密密钥
|
||||||
|
|
||||||
进入[用户中心](https://qauth.cn/config/secret)获取`UserSecretKey`
|
进入[用户中心](https://qauth.cn/config/secret)获取`UserSecretKey`
|
||||||
|
|
||||||
#### 修改现有项目
|
## 修改现有项目
|
||||||
|
|
||||||
修改自己项目的登录逻辑，发起[获取二维码](/api/qrcode)请求
|
修改自己项目的登录逻辑，发起[获取二维码](/api/qrcode)请求
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,16 +1,18 @@
|
||||||
### 通过code获取用户信息接口
|
# 通过code获取用户信息接口
|
||||||
|
|
||||||
#### 1、接口地址
|
## 1、接口地址
|
||||||
|
|
||||||
> http://api.qauth.cn/user
|
> http://api.qauth.cn/user
|
||||||
|
|
||||||
#### 2、接口说明
|
## 2、接口说明
|
||||||
|
|
||||||
通过code、appkey、usersecret获取用户信息接口
|
通过code、appkey、usersecret获取用户信息接口
|
||||||
|
|
||||||
#### 3、请求类型 `GET`
|
## 3、请求类型
|
||||||
|
|
||||||
#### 4、请求参数
|
`GET`
|
||||||
|
|
||||||
|
## 4、请求参数
|
||||||
|
|
||||||
|参数|说明|必须|备注|
|
|参数|说明|必须|备注|
|
||||||
|--|--|--|--|
|
|--|--|--|--|
|
||||||
|
|
@ -19,10 +21,29 @@
|
||||||
|secret|加密秘钥|是|开发者在QuickAuth网站中的UserSecretKey|
|
|secret|加密秘钥|是|开发者在QuickAuth网站中的UserSecretKey|
|
||||||
|isTest|是否测试调用|否|true or false, QuickAuth网站中点测试按钮生成的code可调用，正式环境请勿传该参数|
|
|isTest|是否测试调用|否|true or false, QuickAuth网站中点测试按钮生成的code可调用，正式环境请勿传该参数|
|
||||||
|
|
||||||
5、返回结果
|
## 5、返回结果
|
||||||
|
|
||||||
|key|value|说明|
|
|key|value|说明|
|
||||||
|--|--|--|
|
|--|--|--|
|
||||||
|code|0或1|正确0，错误1|
|
|code|0或1|正确0，错误1|
|
||||||
|msg|string|提示信息|
|
|msg|string|提示信息|
|
||||||
|res|结果|用户的基本信息包含openid、nickname、avatarurl|
|
|res|结果|用户的基本信息包含openid、nickname、avatarurl|
|
||||||
|
|
||||||
|
### 返回结果示例
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 0,
|
||||||
|
"msg": "success",
|
||||||
|
"res": {
|
||||||
|
"openId": "03af4fa4-f755-471d-a9be-1080c133ed03",
|
||||||
|
"nickName": "wixy",
|
||||||
|
"avatarUrl": "https://gravatar.loli.net/avatar",
|
||||||
|
"authType": "wechat",//调用/oauth接口时传入的参数
|
||||||
|
"redirectUrl": "https://qauth.cn/app",//调用/oauth接口时传入的参数
|
||||||
|
"detailType": "offiaccount",//调用/oauth接口时传入的参数
|
||||||
|
"email": "wixy@qq.com"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
@ -0,0 +1,55 @@
|
||||||
|
# 通过code获取用户授权信息接口
|
||||||
|
|
||||||
|
## 1、接口地址
|
||||||
|
|
||||||
|
> <http://api.qauth.cn/authinfo>
|
||||||
|
|
||||||
|
## 2、接口说明
|
||||||
|
|
||||||
|
通过code、appkey、usersecret获取用户信息接口
|
||||||
|
|
||||||
|
2.1.0.0版本新增的接口，修改了数据输出格式，用于替换旧版/user接口
|
||||||
|
|
||||||
|
## 3、请求类型
|
||||||
|
|
||||||
|
`GET`
|
||||||
|
|
||||||
|
## 4、请求参数
|
||||||
|
|
||||||
|
|参数|说明|必须|备注|
|
||||||
|
|--|--|--|--|
|
||||||
|
|code|用户信息获取标识|是|用户完成扫码登录后重定向到开发者的应用回调地址时携带的参数|
|
||||||
|
|appkey|应用标识|是|开发者在QuickAuth网站创建应用的AppKey|
|
||||||
|
|secret|加密秘钥|是|开发者在QuickAuth网站中的UserSecretKey|
|
||||||
|
|isTest|是否测试调用|否|true or false, QuickAuth网站中点测试按钮生成的code可调用，正式环境请勿传该参数|
|
||||||
|
|
||||||
|
## 5、返回结果
|
||||||
|
|
||||||
|
|key|value|说明|
|
||||||
|
|--|--|--|
|
||||||
|
|code|0或1|正确0，错误1|
|
||||||
|
|msg|string|提示信息|
|
||||||
|
|res|结果|用户授权信息|
|
||||||
|
|
||||||
|
### 返回结果示例
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 0,
|
||||||
|
"msg": "success",
|
||||||
|
"res": {
|
||||||
|
"state": "login",//调用/oauth接口时传入的参数
|
||||||
|
"redirectUrl": "https://qauth.cn/app",//调用/oauth接口时传入的参数
|
||||||
|
"authType": "wechat",//调用/oauth接口时传入的参数
|
||||||
|
"detailType": "offiaccount",//调用/oauth接口时传入的参数
|
||||||
|
"userInfo": {
|
||||||
|
"openId": "03af4fa4-f755-471d-a9be-1080c133ed03",
|
||||||
|
"nickName": "wixy",
|
||||||
|
"avatarUrl": "https://gravatar.loli.net/avatar",
|
||||||
|
"mobile": "13888888888",//仅验证码登录方式返回
|
||||||
|
"email": "wixy@qq.com"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
@ -1,30 +0,0 @@
|
||||||
## #基础接口（永久免费使用）
|
|
||||||
|
|
||||||
> 该接入方式为微信小程序扫码授权的方式
|
|
||||||
|
|
||||||
> 前端点击微信扫码登录按钮跳转到QuickAuth扫码登录界面（或者弹出扫码登录窗口），用户扫码完成后重定向到开发者配置的回调地址并携带相应的参数
|
|
||||||
|
|
||||||
### 接口列表
|
|
||||||
|
|
||||||
1. [扫码界面(/qrconnect)](/guide/free/qrconnect)
|
|
||||||
2. [获取用户信息(/user)](/guide/free/user)
|
|
||||||
|
|
||||||
#### 创建应用
|
|
||||||
|
|
||||||
1、登录[quickauth](https://qauth.cn)网站并创建[接入应用](https://qauth.cn/app)
|
|
||||||
|
|
||||||
2、填写详细信息和回调地址并发布应用
|
|
||||||
|
|
||||||
3、记住`AppKey`
|
|
||||||
|
|
||||||
#### 获取解密密钥
|
|
||||||
|
|
||||||
进入[用户中心](https://qauth.cn/config/secret)获取`UserSecretKey`
|
|
||||||
|
|
||||||
#### 修改现有项目
|
|
||||||
|
|
||||||
1、修改自己项目的登录逻辑，携带参数appkey和state跳转到[扫码界面](/guide/free/qrconnect)
|
|
||||||
|
|
||||||
2、用户扫码并授权后界面跳转到应用配置的回调地址并带上参数`code`和`state`
|
|
||||||
|
|
||||||
3、开发者使用code、Appkey、UserSecretKey发起[获取用户信息](/guide/free/user)请求并根据返回信息完成登录逻辑
|
|
||||||
|
|
@ -1,28 +0,0 @@
|
||||||
### 通过code获取用户信息接口
|
|
||||||
|
|
||||||
#### 1、接口地址
|
|
||||||
|
|
||||||
> http://api.qauth.cn/user
|
|
||||||
|
|
||||||
#### 2、接口说明
|
|
||||||
|
|
||||||
通过code、appkey、usersecret获取用户信息接口
|
|
||||||
|
|
||||||
#### 3、请求类型 `GET`
|
|
||||||
|
|
||||||
#### 4、请求参数
|
|
||||||
|
|
||||||
|参数|说明|必须|备注|
|
|
||||||
|--|--|--|--|
|
|
||||||
|code|用户信息获取标识|是|用户完成扫码登录后重定向到开发者的应用回调地址时携带的参数|
|
|
||||||
|appkey|应用标识|是|开发者在QuickAuth网站创建应用的AppKey|
|
|
||||||
|secret|加密秘钥|是|开发者在QuickAuth网站中的UserSecretKey|
|
|
||||||
|isTest|是否测试调用|否|true or false, QuickAuth网站中点测试按钮生成的code可调用，正式环境请勿传该参数|
|
|
||||||
|
|
||||||
5、返回结果
|
|
||||||
|
|
||||||
|key|value|说明|
|
|
||||||
|--|--|--|
|
|
||||||
|code|0或1|正确0，错误1|
|
|
||||||
|msg|string|提示信息|
|
|
||||||
|res|结果|用户的基本信息包含openid、nickname、avatarurl|
|
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
# 接入指南
|
||||||
|
|
||||||
|
> QuickAuth接口主要包括微信扫码登录（H5、小程序、开放平台）、QQ、Github、支付宝等多种登录方式
|
||||||
|
|
||||||
|
## 接口列表
|
||||||
|
|
||||||
|
1. [授权登录界面(/oauth)](/guide/oauth)
|
||||||
|
2. [获取用户授权信息（/user接口的升级版）(/authinfo)](/guide/authinfo)
|
||||||
|
|
||||||
|
### 创建应用
|
||||||
|
|
||||||
|
1、登录[quickauth](https://qauth.cn)网站并创建[接入应用](https://qauth.cn/app)
|
||||||
|
|
||||||
|
2、填写详细信息和回调地址并发布应用
|
||||||
|
|
||||||
|
3、记住`AppKey`
|
||||||
|
|
||||||
|
### 获取解密密钥
|
||||||
|
|
||||||
|
进入[用户中心](https://qauth.cn/config/secret)获取`UserSecretKey`
|
||||||
|
|
||||||
|
### 修改现有项目
|
||||||
|
|
||||||
|
1、修改自己项目的登录逻辑，携带参数type、appkey和state跳转到[登录授权界面](/guide/oauth)
|
||||||
|
|
||||||
|
2、用户扫码并授权后界面跳转到应用配置的回调地址并带上参数`code`和`state`
|
||||||
|
|
||||||
|
3、开发者使用code、Appkey、UserSecretKey发起[获取用户信息](/guide/authinfo)请求并根据返回信息完成登录逻辑
|
||||||
|
|
@ -1,30 +1,34 @@
|
||||||
### QuickAuth登录授权界面
|
# QuickAuth登录授权界面
|
||||||
|
|
||||||
#### 1、接口地址
|
## 1、接口地址
|
||||||
|
|
||||||
> http://api.qauth.cn/oauth
|
> <http://api.qauth.cn/oauth>
|
||||||
|
|
||||||
#### 2、接口说明
|
## 2、接口说明
|
||||||
|
|
||||||
开发者应用点击第三方登录按钮跳转的界面
|
开发者应用点击第三方登录按钮跳转的界面
|
||||||
|
|
||||||
#### 3、请求参数
|
## 3、请求参数
|
||||||
|
|
||||||
|参数|必须|备注|
|
|参数|必须|备注|
|
||||||
|--|--|--|
|
|--|--|--|
|
||||||
|type|是|授权方式，支持（wechat、qq、github、gitee）|
|
|type|是|授权方式，支持（wechat、qq、github、gitee、alipay、weibo、dingtalk、sms）|
|
||||||
|detailType|否|type传入wechat是，可传入detailType参数来控制微信接入的调用方式，支持（offiaccount、miniprogram和oplatform），不传或者传入其他值则默认为offiaccount|
|
|detailType|否|type传入wechat时，可传入detailType参数来控制微信接入的调用方式，支持（offiaccount、miniprogram和oplatform），不传或者传入其他值则默认为offiaccount|
|
||||||
|appkey|是|开发者在QuickAuth网站创建应用的AppKey|
|
|appkey|是|开发者在QuickAuth网站创建应用的AppKey|
|
||||||
|state|是|开发者应用附加信息|
|
|state|否|开发者应用附加信息|
|
||||||
|
|redirect|否|授权成功后需要重新跳转的地址|
|
||||||
|
|
||||||
|
### 备注
|
||||||
|
|
||||||
##### 备注
|
|
||||||
type参数传wechat，detailType传入offiaccount或默认传参时，如果是在微信客户端内打开网站，则不需要扫码，直接完成静默授权逻辑，实现无感登录
|
type参数传wechat，detailType传入offiaccount或默认传参时，如果是在微信客户端内打开网站，则不需要扫码，直接完成静默授权逻辑，实现无感登录
|
||||||
|
|
||||||
#### 4、重定向时携带的参数
|
## 4、重定向时携带的参数
|
||||||
|
|
||||||
|
用户完成授权后会重定向到用户配置的回调地址上，并携带code和state参数
|
||||||
|
|
||||||
|参数|说明|
|
|参数|说明|
|
||||||
|--|--|
|
|--|--|
|
||||||
|code|用于获取授权用户信息的code，该code只能使用一次|
|
|code|用于获取授权用户信息的code，该code只能使用一次|
|
||||||
|state|调用时设置的state|
|
|state|调用时设置的state|
|
||||||
|
|
||||||
> 示例： https://api.qauth.cn/oauth?type=wechat&appkey=e0176d4b&state=login
|
> 示例： <https://api.qauth.cn/oauth?type=wechat&appkey=e0176d4b&state=login>
|
||||||
|
|
@ -0,0 +1,12 @@
|
||||||
|
# 推广奖励机制
|
||||||
|
|
||||||
|
项目推广初期，我们开启了推广奖励机制，具体规则如下：
|
||||||
|
|
||||||
|
* 初次注册的用户将会获得15天订阅会员和10条短信包
|
||||||
|
* 通过邀请码邀请用户注册，每邀请1人成功注册则获得15天订阅会员奖励
|
||||||
|
* 使用邀请码成功注册的新用户，同样也会获得15天订阅会员奖励
|
||||||
|
* 使用邀请码注册的用户产生的订单也会有相应的返利
|
||||||
|
* 被邀请用户购买的订阅会员的天数会产生10%奖励发送到邀请人账户
|
||||||
|
* 被邀请用户购买的短信包条数会产生5%奖励发送到邀请人账户(奖励的短信包有效期为3个月)
|
||||||
|
|
||||||
|
注：该规则后期会根据项目运营情况及时更新
|
||||||
|
|
@ -1,2 +1 @@
|
||||||
### QuickAuth 接口列表
|
# QuickAuth 接口列表
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,14 +1,13 @@
|
||||||
### QuickAuth 登录接入应用
|
## QuickAuth 登录接入应用
|
||||||
|
|
||||||
<br/>
|
|
||||||
|
|
||||||
### 应用
|
### 应用
|
||||||
|
|
||||||
- [QuickAuth](https://qauth.cn) （QuickAuth项目网站）
|
- [QuickAuth](https://qauth.cn) （QuickAuth项目网站）
|
||||||
- [SiliSchedule](https://sc.wixy.cn) （HTTP定时任务管理系统）
|
|
||||||
- [UltronBlog](https://blog.wixy.cn) （wixy的个人博客）
|
更多请参照QuickAuth平台 [QuickAuth](https://qauth.cn/home)
|
||||||
|
|
||||||
### 插件
|
### 插件
|
||||||
|
|
||||||
- [QuickAuthLogin](https://gitee.com/wixy/QuickAuthLogin) （Typecho博客微信扫码登录插件）
|
- [QualPro](https://github.com/mr-wixy/QualPro) （WordPress集成登录插件）
|
||||||
- [QuickAuthLogin-WP](https://gitee.com/wixy/QuickAuthLogin-WP) （WordPress微信扫码登录插件）
|
- [QuickAuthLogin](https://github.com/mr-wixy/QuickAuthLogin) （Typecho博客微信扫码登录插件）
|
||||||
|
- [QuickAuthLogin-WP](https://github.com/mr-wixy/QuickAuthLogin-WP) （WordPress微信扫码登录插件）
|
||||||
|
|
|
||||||
|
|
@ -5,8 +5,13 @@
|
||||||
- [x] 接入Gitee登录
|
- [x] 接入Gitee登录
|
||||||
- [x] 微信H5扫码登陆
|
- [x] 微信H5扫码登陆
|
||||||
- [x] 微信客户端内静默授权登陆
|
- [x] 微信客户端内静默授权登陆
|
||||||
- [ ] 微信开放平台扫码登陆
|
- [x] 微信开放平台扫码登陆
|
||||||
|
- [x] 接入支付宝登录
|
||||||
|
- [x] 接入微博登录
|
||||||
|
- [x] 接入钉钉登录
|
||||||
|
- [x] 新增推广奖励机制
|
||||||
|
- [x] 新增验证码登录方式
|
||||||
- [ ] Typecho插件Pro版本
|
- [ ] Typecho插件Pro版本
|
||||||
- [ ] WordPress插件Pro版本
|
- [ ] WordPress插件Pro版本
|
||||||
|
- [ ] 扫码登录二维码展示界面自定义
|
||||||
- [ ] 高级统计接口
|
- [ ] 高级统计接口
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,14 @@
|
||||||
### QuickAuth 更新记录
|
### QuickAuth 更新记录
|
||||||
|
|
||||||
|
#### 2022-12-06
|
||||||
|
|
||||||
|
- 新增微信登录（开放平台）授权模式
|
||||||
|
- 新增微博、钉钉、支付宝授权登录方式
|
||||||
|
- 新增短信验证码登录方式
|
||||||
|
- 新增QualPro插件接入方式
|
||||||
|
- 新增推广奖励机制
|
||||||
|
- 新增登录界面自定义功能（目前仅开放背景和登录框阴影设置）
|
||||||
|
|
||||||
#### 2022-06-15
|
#### 2022-06-15
|
||||||
|
|
||||||
- 新增微信登录（H5）授权模式
|
- 新增微信登录（H5）授权模式
|
||||||
|
|
|
||||||
|
|
@ -1,23 +1,48 @@
|
||||||
## 订阅说明
|
# 订阅说明
|
||||||
|
|
||||||
用户首次登录QuickAuth系统即可获赠30天的订阅会员
|
我们保证QuickAuth项目的正常运行需要必要的经费支出（包括域名、服务器以及其他的费用）
|
||||||
|
|
||||||
#### 普通用户及订阅会员的功能说明
|
同时，开发、维护和运营在线服务也需要时间和精力，我们需要有一定的物质收益作为动力
|
||||||
|
|
||||||
|
所以我们提供免费的基础功能的同时也开放了额外的订阅会员服务
|
||||||
|
|
||||||
|
## 说明
|
||||||
|
|
||||||
|
用户首次登录QuickAuth系统即可获得15天的订阅会员和10条短信验体验包
|
||||||
|
|
||||||
|
通过邀请码注册的用户会额外获得15天订阅会员奖励
|
||||||
|
|
||||||
|
推广奖励机制参见 [推广奖励说明](/invite)
|
||||||
|
|
||||||
|
## 普通用户及订阅会员的功能说明
|
||||||
|
|
||||||
| 功能 | 普通用户 | 订阅会员 |
|
| 功能 | 普通用户 | 订阅会员 |
|
||||||
| ---------------------------- | -------- | -------- |
|
| ---------------------------- | -------- | -------- |
|
||||||
| 可授权用户数量 | 无限制 | 无限制 |
|
| 不限制授权用户数量 | ✓ | ✓ |
|
||||||
| 可创建应用个数 | 3 | 20 |
|
| 不限制创建应用个数 | ✓ | ✓ |
|
||||||
| 微信扫码登陆(小程序) | 支持 | 支持 |
|
| QuickAuthLogin插件 | ✓ | ✓ |
|
||||||
| Typecho、WordPress插件普通版 | 支持 | 支持 |
|
| QualPro插件 | ✓ | ✓ |
|
||||||
| 自定义小程序码图标 | 不支持 | 支持 |
|
| 微信扫码登陆(小程序) | ✓ | ✓ |
|
||||||
| Typecho、WordPress插件高级版 | 不支持 | 支持 |
|
| QQ登陆 | ✓ | ✓ |
|
||||||
| 微信扫码登陆(H5) | 不支持 | 支持 |
|
| GitHub登录 | ✓ | ✓ |
|
||||||
| 微信客户端静默登陆 | 不支持 | 支持 |
|
| Gitee登录 | ✓ | ✓ |
|
||||||
| 微信扫码登陆(开放平台) | 不支持 | 支持 |
|
| 支付宝登录 | ✓ | ✓ |
|
||||||
| QQ登陆 | 不支持 | 支持 |
|
| 微博登录 | ✓ | ✓ |
|
||||||
| GitHub登录 | 不支持 | 支持 |
|
| 钉钉登录 | ✓ | ✓ |
|
||||||
| Gitee登录 | 不支持 | 支持 |
|
| 微信扫码登陆(H5) | ✗ | ✓ |
|
||||||
| 统计接口 | 不支持 | 支持 |
|
| 微信扫码登陆(开放平台) | ✗ | ✓ |
|
||||||
| 技术支持 | 付费 | 免费 |
|
| 微信客户端静默登陆 | ✗ | ✓ |
|
||||||
|
| 短信验证码登录 | ✗ | ✓ |
|
||||||
|
| 扫码登录界面自定义背景 | ✗ | ✓ |
|
||||||
|
| 自定义小程序码图标 | ✗ | ✓ |
|
||||||
|
| 统计接口 | ✗ | ✓ |
|
||||||
|
|
||||||
|
## 短信验证码套餐包
|
||||||
|
|
||||||
|
短信验证码套餐包仅适用于验证码登录方式，主要用于运营商通信费用，采用其他登录方式的网站不需要购买
|
||||||
|
|
||||||
|
目前验证码发送模板和签名（思礼网络）均为固定模式，验证码短信效果如下
|
||||||
|
|
||||||
|
> 【思礼网络】您的登录验证码：0****5，如非本人操作，请忽略本短信。
|
||||||
|
|
||||||
|
后期平台计划会推出自定义签名功能
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue