# GUNION SDK 开发手册 for Web（AUTH 功能）
# 说明
注意事项
- 参数中的 value 均需要 UrlEncode 编码 【什么是 UrlEncode (opens new window)、一文详解 URLEncode (opens new window)】
- 参数区分大小写
# 登录页面：redirect 模式（location.href）
地址：https://mygm.sdo.com/v1/oauth/authorize
样例：
https://mygm.sdo.com/v1/oauth/authorize?appid=1&iframe=1&brand_type=3&redirect_url=https%3a%2f%2fwww.sdo.com%3fa%3d1%26b%3d2
1
2
2
| 参数名 | 参数含义 | 可选 | 示例说明或备注 |
|---|---|---|---|
| redirect_url | 登录成功后返回的应用地址，会返回ticket | 必填 | returnURL=https%3A%2F%2Fpre%2Ewww%2Esdo%2Ecom 注意，需要 urlencode，尤其是返回的页面有自己的入参。 例如返回的页面期望是：https://a.sdo.com?a=1&b=2 需要入参为： returnURL=https%3a%2f%2fa.sdo.com%3fa%3d1%26b%3d2 |
| appid | 应用编码，整数。用于统计各个应用的登录量的凭据 | 必填 | 示例：appId=201 此appId请通过数字编码申请流程进行申请，第三方应用请联系公司接口人。 |
| iframe | 是否是iframe模式 | 必填 | 此模式下必须填1（iframe=1） |
| brand_type | 品牌类型 | 必填 | 此模式下必须填3（brand_type=3） logo在服务端配置（请联系产品负责人） |
# 注销页面：redirect 模式（location.href）
地址：https://mygm.sdo.com/v1/sso/logout
// 样例（任意客户端OAuth模式）：
// 使用范围：任意类型客户端，任意操作系统平台，任意游戏框架（具体见底部附录，并有实现时序图）
https://mygm.sdo.com/v1/sso/logout?redirect_url=https%3a%2f%2fwww.sdo.com%3fa%3d1%26b%3d2
1
2
3
4
2
3
4
| 参数名 | 参数含义 | 可选 | 示例说明或备注 |
|---|---|---|---|
| redirect_url | 登录成功后返回的应用地址，会返回ticket | 必填 | returnURL=https%3A%2F%2Fpre%2Ewww%2Esdo%2Ecom 注意，需要 urlencode，尤其是返回的页面有自己的入参。 例如返回的页面期望是：https://a.sdo.com?a=1&b=2 需要入参为： returnURL=https%3a%2f%2fa.sdo.com%3fa%3d1%26b%3d2 |
# 附录：
# 架构 - 任意客户端使用 Web OAuth 登录
说明：
- 任意客户端指：在Windows、Android、iOS、Linux、鸿蒙等任意系统的客户端，并内置浏览器的情况下。
- 该方案不存在系统特定性，无论系统是Windows、Android、iOS、Linux、鸿蒙等，只要符合客户端程序内含有webview即可实现。
- 该方案不存在框架适配性，无论客户端是VisualStudio、AndroidStudio、Untiy、Cocos、UE、Xbox、PS、NS等，只要实现内置wevbiew即可实现。
- 该方案属于WebOAuth授权模式，不含有登录态状态维持特性。如您在client端的webview中引用，则需要接入方server端成功获得授权认证后，颁发票据给client自行维护自身登录态（例如需要新打开保持登录态，需要通过该方式自行实现登录态的维持）
如下图（点击可看大图）：
← iOS SDK 说明 服务端 API 说明 →