QuickAuth-Doc/docs/guide/oauth.md

34 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2022-12-07 16:14:41 +08:00
# QuickAuth登录授权界面
2022-06-15 23:34:52 +08:00
2022-12-07 16:14:41 +08:00
## 1、接口地址
2022-06-15 23:34:52 +08:00
2022-12-07 16:14:41 +08:00
> <http://api.qauth.cn/oauth>
2022-06-15 23:34:52 +08:00
2022-12-07 16:14:41 +08:00
## 2、接口说明
2022-06-15 23:34:52 +08:00
开发者应用点击第三方登录按钮跳转的界面
2022-12-07 16:14:41 +08:00
## 3、请求参数
2022-06-15 23:34:52 +08:00
|参数|必须|备注|
|--|--|--|
2022-12-07 16:14:41 +08:00
|type|是|授权方式支持wechat、qq、github、gitee、alipay、weibo、dingtalk、sms|
|detailType|否|type传入wechat时可传入detailType参数来控制微信接入的调用方式支持offiaccount、miniprogram和oplatform不传或者传入其他值则默认为offiaccount|
2022-06-15 23:34:52 +08:00
|appkey|是|开发者在QuickAuth网站创建应用的AppKey|
2022-12-07 16:14:41 +08:00
|state|否|开发者应用附加信息|
|redirect|否|授权成功后需要重新跳转的地址|
### 备注
2022-06-15 23:34:52 +08:00
2022-06-20 17:28:01 +08:00
type参数传wechatdetailType传入offiaccount或默认传参时如果是在微信客户端内打开网站则不需要扫码直接完成静默授权逻辑实现无感登录
2022-06-15 23:34:52 +08:00
2022-12-07 16:14:41 +08:00
## 4、重定向时携带的参数
用户完成授权后会重定向到用户配置的回调地址上并携带code和state参数
2022-06-15 23:34:52 +08:00
|参数|说明|
|--|--|
|code|用于获取授权用户信息的code该code只能使用一次|
|state|调用时设置的state|
2022-12-07 16:14:41 +08:00
> 示例: <https://api.qauth.cn/oauth?type=wechat&appkey=e0176d4b&state=login>