跳到主要内容

LI PASS 网页配置

初始化参数类型描述备注
envstringSDK 环境,test 为测试环境
更多信息,请参见 获取部署集群信息
必填
gameIDnumber游戏 ID必填
appIDstringApp ID,Player Network 控制台分配的 ACCOUNT_APP_ID必填
WebIDstringWeb ID,Player Network 控制台分配的 Web ID选填
configobject高级配置选填

config

注意

如果您已在 Player Network 控制台创建 LI PASS web 的配置,只需在控制台选择配置即可,无需手动配置 config 中的大部分参数。Player Network 控制台下发的配置优先级高于 config

参数 类型 描述 备注
isMobile boolean 是否显示手机界面 选填
默认值: false(显示 PC 界面)

如果在 Player Network 控制台将 Web 端布局 配置为 自定义配置,则需自行判断设备环境来动态决定 isMobile 的值
socialList string[] 支持第三方登录渠道列表
facebook, twitter, google, apple, line, steam, epic, ps5, discord, vk, twitch, qq, wechat
选填
默认值: []
socialParams object 第三方登录渠道的额外配置 Apple、Kakao v3 渠道必填
默认值: {}
renderMode string 显示模式
inline:普通模式
modal:模态框模式
选填
默认值: inline
loginWithCode object 验证码登录配置 选填
默认值: { enable: true, registerType: 'manual'}
loginWithPwd object 密码登录配置 选填
默认值: { enable: true, registerType: 'manual'}
procedureSwitch object 流程开关 选填
默认值: { region: false, adultStatus: false, agreement: false, registerPassword: 'onDemand'}
crossGameLink boolean 是否开启跨游戏关联账号功能 选填
默认值: false

暂不支持在 Player Network 控制台配置
serviceIntro boolean 是否开启 LI PASS 服务介绍入口 选填
默认值: false

暂不支持在 Player Network 控制台配置
langType string 默认语言,详见 语言列表 选填
默认值: en

不支持在 Player Network 控制台配置

socialParams

参数类型描述备注
appleAppIdstringApple 渠道 Web app IDApple 渠道必填
platformnumber指定 Garena 登录的方式
1:Garena
3:Facebook
8:Google
10:Apple
11:Twitter
Garena 渠道选填
kakaov3AppIdstringKakao app IDKakao v3 渠道必填
kakaov3JsKeystringKakao Javascript 密钥Kakao v3 渠道必填

loginWithCode

参数类型描述备注默认值
enableboolean是否开启验证码登录选填true
registerTypestring注册类型
manual:仅允许用户手动注册
auto:未注册的用户可以通过验证码登录自动注册
disabled:关闭注册功能,仅允许存量用户登录
选填manual

loginWithPwd

参数类型描述备注默认值
enableboolean是否开启密码登录选填true
registerTypestring注册类型
manual:仅允许用户手动注册
disabled:关闭注册功能,仅允许存量用户登录
选填manual

procedureSwitch

类型 描述 备注
region boolean 地区开关,影响 adultStatus agreement 的展示

false:注册时无需填写地区,登录时不会检查用户是否填写了地区
true:注册时要求填写地区,登录时检查用户是否填写了地区,若未填写则需用户补充
选填
默认值: false
adultStatus boolean 成年状态开关,依赖于 region 开启状态,单独开启此开关无效

false:注册时无需填写生日或确认是否成年条款,登录时不会检查用户是否已填写成年状态相关信息。
true:根据用户选择的区域,在注册时要求填写生日或确认是否成年条款,登录时检查用户是否已填写成年状态相关信息,若未填写则需用户补充。无需合规认证的区域不显示相关内容。
选填
默认值: false
agreement boolean 协议条款开关,依赖于 region 开启状态

基础协议条款:Terms of Service [必选]、Privacy Policy [必选]、营销邮件订阅 [可选]
地区特性协议条款:Data Transfer Notice [必选](欧洲经济区/瑞士,除英国)、夜间营销邮件订阅 [可选](仅韩国)

false:注册时不会展示任何协议条款,登录时不会检查用户各协议条款的勾选状态。
true region=true:根据用户选择的区域,在注册时展示所有协议条款,登录时检查用户各协议条款的勾选状态。必选条款未勾选则需用户补充勾选,可选条款在每个网站仅有一次供用户勾选的机会。
true region=false:注册时仅展示基础协议条款,登录时仅检查用户基础协议条款的勾选状态。若必选条款未勾选,则需用户补充勾选。
选填
默认值: false
unrestrictedRegion string[] 对默认限制的地区放开限制
由三位地区码组成的数组,示例:['356']
选填
默认值: []

暂不支持在 Player Network 控制台配置
registerPassword string 密码设置的三种状态选择,影响 loginWithPwd 的流程
用户使用密码登录时,若未设置过密码,则弹窗指引用户设置密码或者使用验证码登录。

disabled:注册时无需设置密码,注册流程将不包含设置密码的界面。
required:注册时必须设置密码,用户不可跳过。
onDemand:注册时用户可按需选择是否设置密码。
选填
默认值: onDemand