# GHOME SDK 开发手册 for Web 国际版
# 1. 前言
本文用于指导游戏开发商接入 GHome-International Web 版本 SDK。
文中包含 H5 和 Iframe 的邮箱登录、邮箱注册、邮箱重置密码页面的接入说明。
重要说明
- 所有入参均默认区分大小写，请严格按照文档要求实现（建议复制黏贴以免有误，不要手敲）
# 2. 邮箱登录页面
该登录页包含登录、注册、重置密码三项功能，可通过传入可选的 action 来优先展示其中某一项功能。
# 2.1 地址
https://abroad-sin-wlogin.shengqugames-corp.com/login (opens new window)
注意：页面必须含有下面入参的必传字段，不能为空。
# 2.2 入参说明
| 参数名 | 是否必传 | 含义 | 说明 |
|---|---|---|---|
| appId | 必传 | 游戏 appId | |
| platform | 必传 | 使用平台 | H5：1，Iframe：2，WebView：3（不传会默认 H5） |
| return_url | 必传 | 登录成功后，重定向的地址 | 需要 encodeURIComponent 编码 |
| back_url | 可传 | iframe 三方登录失败后，重定向的地址 | 需要 encodeURIComponent 编码，iframe 内嵌时必传 |
| action | 可选 | 当前的操作 | 见下表 |
| scene | 可选 | 使用场景（哪个场景下调用的邮箱登录服务） | |
| lang | 可选 | 国际化语言 | 见 国际化多语言标准 |
action 类型：
| 参数 | 类型 | 说明 |
|---|---|---|
| webEmailCodeLogin | string | 邮箱验证登录 |
| webEmailStaticLogin | string | 邮箱静密登录 |
| webRegister | string | 邮箱注册 |
| webResetPassword | string | 邮箱重置密码 |
# 2.3 示例
H5 打开登录页面：
https://abroad-sin-wlogin.shengqugames-corp.com/login?appId=791000008&platform=1&return_url=https%3A%2F%2Fwww.baidu.com&lang=pt
Iframe 拉起登录页面：
TIP
💡请注意：
- 由于浏览器的跨站点跟踪防护策略，许多现代浏览器会对 iframe 内嵌的场景进行不同程度的限制；
- 第三方 OAuth 授权页面禁止通过 iframe 内嵌到任何站点；
- GHOME 的三方登录策略是：在点击三方按钮后，将浏览器最顶层窗口（window.top）整个跳转到 GHOME 的登录页，从而绕过 iframe 的限制；
- 登录成功后携带票据重定向到
return_url，登录失败则重定向到back_url。
https://abroad-sin-wlogin.shengqugames-corp.com/login?appId=791000008&platform=2&return_url=https%3A%2F%2Fwww.baidu.com&back_url=https%3A%2F%2Fwww.sdo.com&lang=zh-cn
# 2.4 响应参数
| 参数 | 类型 | 说明 |
|---|---|---|
| loginType | int | 绑定类型，见下表 |
| token | string | 登录态 |
| userId | string | 用户 appmid |
| ticket | string | 登录小票 |
loginType 类型：
| 参数 | 类型 | 说明 |
|---|---|---|
| 588 | string | 邮箱 |
| 502 | string | |
| 503 | string | |
| 504 | string | Apple |
| 505 | string | |
| 506 | string | Line |
# 2.4.1 响应形式
登录、注册、重置密码成功后，系统会在重定向的 return_url 网址参数（query parameters）上返回用户信息。
访问成功响应：
https://www.baidu.com/?token=WT2C58B158AC024A7DACAEFA63AE7B9003&userId=10589092&loginType=503&ticket=your_ticket
# 3. 登出
# 3.1 地址
https://abroad-sin-wlogin.shengqugames-corp.com/logout (opens new window)
# 3.2 入参说明
| 参数 | 是否必传 | 说明 |
|---|---|---|
| appId | Y | 游戏 appId |
| return_url | Y | 需要 encodeURIComponent 编码，登出成功后，返回重定向地址 |
# 3.3 示例
https://abroad-sin-wlogin.shengqugames-corp.com/logout?appId=791000008&return_url=https%3A%2F%2Fwww.baidu.com
# 3.4 响应参数
- 成功：重定向到指定的
return_url； - 失败：重定向到指定的
return_url，并以网址参数的形式携带错误信息error、错误码errorCode。
# 4. 生成 ticket 小票
# 4.1 地址
https://abroad-sin-wlogin.shengqugames-corp.com/webticket (opens new window)
# 4.2 入参说明
| 参数 | 是否必传 | 说明 |
|---|---|---|
| appId | Y | 游戏 appId |
| return_url | Y | 需要 encodeURIComponent 编码，用于后台校验发起的页面是否合法，并最终重定向到该页面 |
| lang | N | 国际化语言 见 国际化多语言标准 |
# 4.3 示例
https://abroad-sin-wlogin.shengqugames-corp.com/webticket?appId=791000008&return_url=https%3A%2F%2Fwww.baidu.com&lang=en
# 4.4 响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| ticket | string | 登录小票 |
- 成功：重定向到指定的
return_url，并以网址参数的形式携带票ticket； - 失败：重定向到指定的
return_url，并以网址参数的形式携带错误信息error、错误码errorCode。
# 5. 龙之谷 - 国际版腾讯 LI 账号 web SDK 登录
该页面已接入 Tencent LI Pass Web SDK (opens new window)，给用户进行腾讯国际版 LI 账号登录。
登录成功后，会校验该用户是否需要迁移回盛趣账号体系。如需要迁移，则会跳转至盛趣账号迁移登录页面
# 5.1 地址
https://abroad-sin-wlogin.shengqugames-corp.com/transfer/{region} (opens new window)
# 5.2 入参说明
| 参数 | 是否必传 | 说明 |
|---|---|---|
| {region} | Y | 动态路由参数，地区码：tw - 台湾，ko - 韩国，ja - 日本，global - 全球 |
| appId | Y | 盛趣 appid |
| platform | Y | web 端传 5（即 H5） |
| lang | N | 国际化语言，查阅Tencent LI Config 说明 (opens new window) |
# 5.3 示例
https://abroad-sin-wlogin.shengqugames-corp.com/transfer/tencent/tw?appId=791000668&platform=5
# 6. 龙之谷 - 盛趣账号迁移登录
该页面给用户进行盛趣账号的登录。在登录成功后，会实现账号迁移。
# 6.1 地址
https://abroad-sin-wlogin.shengqugames-corp.com/transfer/login (opens new window)
# 6.2 入参说明
| 参数 | 是否必传 | 说明 |
|---|---|---|
| appId | Y | 盛趣 appid |
| platform | Y | 使用平台， 5：账号迁移的 H5 平台，6：账号迁移的 WebView 平台 |
| regionId | Y | 区域码，1 - 台湾，2 - 韩国，3 - 日本，9 - 全球 |
| lang | N | 国际化语言 见 国际化多语言标准 |
| gameId | Y | Tencent LI GameID， 驼峰大小写不敏感（gameid 也可） |
| channelId | Y | Tencent LI 登录平台类型， 驼峰大小写不敏感（channelid 也可） |
| openId | N | Tencent LI 账号用户唯一标识，Web 绑定必传 |
| token | N | Tencent LI 账号用户登录态，Web 绑定必传 |
| encodeparam | N | Tencent LI 加密信息，游戏内（WebView）绑定必传 |
请注意：
- platform = 5，即 Web 页面绑定，必传
openId和token； - platform = 6，即 游戏内（WebView） 绑定，必传
encodeparam。
# 6.3 示例
- web 绑定
https://abroad-sin-wlogin.shengqugames-corp.com/transfer/login?appId=791000668&platform=5&openId=2212996205215586704&token=d0e4fbfd2dbe43e62a878782ae6ce7fd5ef28fde®ionId=1&gameId=29011&channelId=131
- 游戏内绑定
https://abroad-sin-wlogin.shengqugames-corp.com/transfer/login?appId=791000668&platform=6®ionId=1&gameid=29011&channelid=6&encodeparam=xxxxxx
# 7. 注销
# 7.1 地址
https://abroad-sin-wlogin.shengqugames-corp.com/revoke (opens new window)
# 7.2 入参说明
| 参数 | 是否必传 | 含义 | 说明 |
|---|---|---|---|
| appId | 必传 | 游戏 appId | |
| channel | 必传 | sdk 端渠道号 | 目前无特定约定需求时传递 google |
| platform | 必传 | 使用平台 | 1:H5，2: Iframe，3: iOS，4: Android |
| sdk2WebTicket | 可选 | 登录态票据 | 5 分钟过期，一次有效。platform为1,2时可不传递 |
| lang | 可选 | 国际化语言 | 大小写不敏感 见 国际化多语言标准 |
| target | 可选 | 指定展示的部分流程 | 类型见 Target，默认注销条件页面。比如，用户跳转查看协议后，需指定 target=2 重新跳回注销页面。platform为1,2时可不传递 |
Target 类型
| 枚举类型 | 含义 |
|---|---|
| 1 | 注销条件页面 |
| 2 | 注销协议页面 |
| 3 | 二次确认（倒计时）页面 |
| 4 | 邮箱账号验证页面 |
| 5 | iOS 授权登录页面 |
| 6 | 接受犹豫期页面 |
| 7 | 撤销成功（直接注销） |
| 8 | 撤销成功（附带犹豫期） |
# 7.3 示例
https://abroad-sin-wlogin.shengqugames-corp.com/revoke?appId=791000008&channel=123&lang=en&platform=1
注意事项
- 若platform为1,2时（即web场景时需要从登录地址拼入注销地址获取登录态，即注销地址作为return_url带入登录地址），如下例： https://abroad-sin-wlogin.shengqugames-corp.com/login?appId=791000008&platform=1&lang=en&return_url=https%3a%2f%2fabroad-sin-wlogin.shengqugames-corp.com%2frevoke%3fappId%3d791000008%26channel%3dgoogle%26lang%3den%26platform%3d1
# 8. 国际化多语言标准
三个地址都支持传入 lang 参数来配置语言。目前支持七国八种语言，会从传入的 lang 或 浏览器内置语言中获取，当出现不支持的语言时，系统默认为en。
| 参数 | 说明 |
|---|---|
| zh-CN | 中文（简体） |
| zh-TW | 中文（繁体） |
| en | 英语 |
| ja | 日语 |
| ko | 韩语 |
| pt | 葡萄牙语 |
| th | 泰国语 |
| id | 印尼语 |
其中，lang 参数使用 RFC 1766 规范，大小写不敏感，可以参考 language-strings | 微软官方文档 (opens new window)、RFC 1766) (opens new window)。
注意： lang 只对系统自身的页面起效果，三方登录授权页面目前不支持配置国际化。所以，如果跳转到三方授权确认页面，会展示该三方默认的语言。
← Unity (PC) SDK 接入方案说明 →