update document for Version 2.0.0
This commit is contained in:
parent
637f08582b
commit
11ab958257
|
@ -7,15 +7,27 @@
|
||||||
### 接入指南
|
### 接入指南
|
||||||
|
|
||||||
- [接入指南](guide/)
|
- [接入指南](guide/)
|
||||||
|
- [订阅功能说明](subscribe)
|
||||||
- [信息的加解密](other/encrypt)
|
- [信息的加解密](other/encrypt)
|
||||||
|
|
||||||
### 接口列表
|
### 接口列表
|
||||||
|
|
||||||
1. [扫码界面(/qrconnect)](/guide/method1/qrconnect)
|
#### 普通接口(免费用户永久可用)
|
||||||
|
|
||||||
|
1. [小程序扫码登录界面(/qrconnect)](/guide/method1/qrconnect)
|
||||||
2. [获取用户信息(/user)](/guide/method1/user)
|
2. [获取用户信息(/user)](/guide/method1/user)
|
||||||
3. [获取二维码(/qrcode)](/guide/method2/qrcode)
|
|
||||||
4. [获取扫码状态(/qrcode/state)](/guide/method2/state)
|
#### 高级接口(订阅会员可用)
|
||||||
5. [用户信息解密(/decrypt)](/guide/method2/decrypt)
|
|
||||||
|
1. [授权登录界面(/oauth)](/guide/advanced/oauth)
|
||||||
|
2. [获取用户信息(/user)](/guide/advanced/user)
|
||||||
|
|
||||||
|
#### 即将停止维护的接口
|
||||||
|
|
||||||
|
1. [获取二维码(/qrcode)](/guide/archived/qrcode)
|
||||||
|
2. [获取扫码状态(/qrcode/state)](/guide/archived/state)
|
||||||
|
3. [用户信息解密(/decrypt)](/guide/archived/decrypt)
|
||||||
|
|
||||||
|
|
||||||
### 接入应用
|
### 接入应用
|
||||||
|
|
||||||
|
|
|
@ -1,12 +1,16 @@
|
||||||
* [文档首页](/)
|
* [文档首页](/)
|
||||||
|
* [订阅会员功能说明](subscribe)
|
||||||
* [接入指南](guide/)
|
* [接入指南](guide/)
|
||||||
* [接入方式一(简单)](guide/method1/)
|
* [基础接口(免费)](guide/free/)
|
||||||
* [调用扫码界面](guide/method1/qrconnect)
|
* [调用扫码界面](guide/free/qrconnect)
|
||||||
* [获取用户信息](guide/method1/user)
|
* [获取用户信息](guide/free/user)
|
||||||
* [接入方式二(高级)](guide/method2/)
|
* [高级接口(订阅)](guide/advanced/)
|
||||||
* [获取二维码](guide/method2/qrcode)
|
* [登录授权界面](guide/advanced/oauth)
|
||||||
* [扫码状态](guide/method2/state)
|
* [获取用户信息](guide/advanced/user)
|
||||||
* [用户信息解密](guide/method2/decrypt)
|
* [即将停止维护的接口](guide/archived/)
|
||||||
|
* [获取二维码](guide/archived/qrcode)
|
||||||
|
* [扫码状态](guide/archived/state)
|
||||||
|
* [用户信息解密](guide/archived/decrypt)
|
||||||
* [其他](other/)
|
* [其他](other/)
|
||||||
* [信息的加解密](other/encrypt)
|
* [信息的加解密](other/encrypt)
|
||||||
* [接入应用及插件](other/apps)
|
* [接入应用及插件](other/apps)
|
||||||
|
|
|
@ -0,0 +1,28 @@
|
||||||
|
## #高级接口(订阅会员可用)
|
||||||
|
|
||||||
|
> 高级接口主要包括微信扫码登录、微信客户端内静默授权登录、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)请求并根据返回信息完成登录逻辑
|
|
@ -0,0 +1,29 @@
|
||||||
|
### QuickAuth登录授权界面
|
||||||
|
|
||||||
|
#### 1、接口地址
|
||||||
|
|
||||||
|
> http://api.qauth.cn/oauth
|
||||||
|
|
||||||
|
#### 2、接口说明
|
||||||
|
|
||||||
|
开发者应用点击第三方登录按钮跳转的界面
|
||||||
|
|
||||||
|
#### 3、请求参数
|
||||||
|
|
||||||
|
|参数|必须|备注|
|
||||||
|
|--|--|--|
|
||||||
|
|type|是|授权方式,支持(wechat、qq、github、gitee)|
|
||||||
|
|appkey|是|开发者在QuickAuth网站创建应用的AppKey|
|
||||||
|
|state|是|开发者应用附加信息|
|
||||||
|
|
||||||
|
#### 备注
|
||||||
|
type参数传wechat时,如果是在微信客户端内打开网站,则不需要扫码,直接完成静默授权逻辑,实现无感登录
|
||||||
|
|
||||||
|
#### 4、重定向时携带的参数
|
||||||
|
|
||||||
|
|参数|说明|
|
||||||
|
|--|--|
|
||||||
|
|code|用于获取授权用户信息的code,该code只能使用一次|
|
||||||
|
|state|调用时设置的state|
|
||||||
|
|
||||||
|
> 示例: https://api.qauth.cn/oauth?type=wechat&appkey=e0176d4b&state=login
|
|
@ -1,12 +1,12 @@
|
||||||
## #方式二
|
## #即将停止维护的接口
|
||||||
|
|
||||||
> 开发者通过接口获取二维码并展示,用户扫码授权完成后QuickAuth向开发者配置的回调地址发起授权请求并传入用户信息,开发者根据调用参数和回传参数识别用户登录情况
|
> 开发者通过接口获取二维码并展示,用户扫码授权完成后QuickAuth向开发者配置的回调地址发起授权请求并传入用户信息,开发者根据调用参数和回传参数识别用户登录情况(此接入方式适用范围较窄,目前可以正常调用,后期不排除会停止维护)
|
||||||
|
|
||||||
### 接口列表
|
### 接口列表
|
||||||
|
|
||||||
1. [获取二维码(/qrcode)](/guide/method2/qrcode)
|
1. [获取二维码(/qrcode)](/guide/archived/qrcode)
|
||||||
2. [获取扫码状态(/qrcode/state)](/guide/method2/state)
|
2. [获取扫码状态(/qrcode/state)](/guide/archived/state)
|
||||||
3. [用户信息解密(/decrypt)](/guide/method2/decrypt)
|
3. [用户信息解密(/decrypt)](/guide/archived/decrypt)
|
||||||
|
|
||||||
|
|
||||||
#### 创建应用
|
#### 创建应用
|
|
@ -1,11 +1,13 @@
|
||||||
## #方式一
|
## #基础接口(永久免费使用)
|
||||||
|
|
||||||
|
> 该接入方式为微信小程序扫码授权的方式
|
||||||
|
|
||||||
> 前端点击微信扫码登录按钮跳转到QuickAuth扫码登录界面(或者弹出扫码登录窗口),用户扫码完成后重定向到开发者配置的回调地址并携带相应的参数
|
> 前端点击微信扫码登录按钮跳转到QuickAuth扫码登录界面(或者弹出扫码登录窗口),用户扫码完成后重定向到开发者配置的回调地址并携带相应的参数
|
||||||
|
|
||||||
### 接口列表
|
### 接口列表
|
||||||
|
|
||||||
1. [扫码界面(/qrconnect)](/guide/method1/qrconnect)
|
1. [扫码界面(/qrconnect)](/guide/free/qrconnect)
|
||||||
2. [获取用户信息(/user)](/guide/method1/user)
|
2. [获取用户信息(/user)](/guide/free/user)
|
||||||
|
|
||||||
#### 创建应用
|
#### 创建应用
|
||||||
|
|
||||||
|
@ -21,8 +23,8 @@
|
||||||
|
|
||||||
#### 修改现有项目
|
#### 修改现有项目
|
||||||
|
|
||||||
1、修改自己项目的登录逻辑,携带参数appkey和state跳转到[扫码界面](/guide/method1/qrconnect)
|
1、修改自己项目的登录逻辑,携带参数appkey和state跳转到[扫码界面](/guide/free/qrconnect)
|
||||||
|
|
||||||
2、用户扫码并授权后界面跳转到应用配置的回调地址并带上参数`code`和`state`
|
2、用户扫码并授权后界面跳转到应用配置的回调地址并带上参数`code`和`state`
|
||||||
|
|
||||||
3、开发者使用code、Appkey、UserSecretKey发起[获取用户信息](/guide/method1/user)请求并根据返回信息完成登录逻辑
|
3、开发者使用code、Appkey、UserSecretKey发起[获取用户信息](/guide/free/user)请求并根据返回信息完成登录逻辑
|
|
@ -0,0 +1,28 @@
|
||||||
|
### 通过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|
|
|
@ -3,4 +3,7 @@
|
||||||
- [x] 接入Github登录
|
- [x] 接入Github登录
|
||||||
- [x] 接入QQ登录
|
- [x] 接入QQ登录
|
||||||
- [x] 接入Gitee登录
|
- [x] 接入Gitee登录
|
||||||
- [ ] 小程序自定义登录页面
|
- [x] 微信H5扫码登陆
|
||||||
|
- [x] 微信客户端内静默授权登陆
|
||||||
|
- [ ] 高级统计接口
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,12 @@
|
||||||
### QuickAuth 更新记录
|
### QuickAuth 更新记录
|
||||||
|
|
||||||
|
#### 2022-06-15
|
||||||
|
|
||||||
|
- 新增微信登录(H5)授权模式
|
||||||
|
- 支持微信客户端内静默授权
|
||||||
|
- 新增QQ、Github、Gitee授权登录方式
|
||||||
|
- 新增会员订阅功能
|
||||||
|
|
||||||
#### 2022-04-28
|
#### 2022-04-28
|
||||||
|
|
||||||
- 更新后台首页,展示推荐接入应用
|
- 更新后台首页,展示推荐接入应用
|
||||||
|
|
|
@ -0,0 +1,18 @@
|
||||||
|
## 普通用户及订阅会员的功能说明
|
||||||
|
|
||||||
|
| 功能 | 普通用户 | 订阅会员 |
|
||||||
|
| ---------------------------- | -------- | -------- |
|
||||||
|
| 可授权用户数量 | 无限制 | 无限制 |
|
||||||
|
| 可创建应用个数 | 3 | 20 |
|
||||||
|
| 微信扫码登陆(小程序) | 支持 | 支持 |
|
||||||
|
| Typecho、WordPress插件普通版 | 支持 | 支持 |
|
||||||
|
| 自定义小程序码图标 | 不支持 | 支持 |
|
||||||
|
| Typecho、WordPress插件高级版 | 不支持 | 支持 |
|
||||||
|
| 微信扫码登陆(H5) | 不支持 | 支持 |
|
||||||
|
| 微信客户端静默登陆 | 不支持 | 支持 |
|
||||||
|
| QQ登陆 | 不支持 | 支持 |
|
||||||
|
| GitHub登录 | 不支持 | 支持 |
|
||||||
|
| Gitee登录 | 不支持 | 支持 |
|
||||||
|
| 统计接口 | 不支持 | 支持 |
|
||||||
|
| 技术支持 | 付费 | 免费 |
|
||||||
|
|
Loading…
Reference in New Issue