lt_client
简介
雷霆平台各种功能接入集合
重要说明
本pkg目前仅适用于雷霆平台的旧接口;雷霆平台接口升级以后,本pkg不再适用,请使用pkg.leiting.*
系列接入雷霆平台!!!
提供几种接口:
反沉迷
-
登录上报 - LtAddictionLogin / LtAddictionLoginResult
-
登出上报 - LtAddictionLogout / LtAddictionLogoutResult
-
通知下线 - LtAddictionNotifyLogout
登录验证:
- 登录验证- LtAuth / LtAuthResult
充值相关:
-
充值订单通知 - LtChargeBillNotify
-
订单异常上报 - LtChargeReportBillExecption
数据上报相关:
-
注册日志上报 - LtLogMonitorRegister
-
登入登出日志上报 - LtLogMonitorLoginLogout
-
创角日志上报 - LtLogMonitorCreateRole
-
充值日志上报 - LtLogMonitorCharge
-
广告变现日志上报 - LtLogMonitorAdReport
组件接口
类
LtAddictionLogin
继承自 LtClientRequestBase
防沉迷登录上报
成员变量
变量名 | 类型 | 初始值 | 须初始化 | 描述 |
---|---|---|---|---|
idCard | string | nil | 可选 | 身份唯一标识(SDK服务端登录验证接口返回) 是否必填 - Y |
game | string | nil | 可选 | 游戏标识 是否必填 - Y |
age | int | 0 | 可选 | 年龄(SDK服务端登录验证接口返回) 是否必填 - Y |
isFast | int | 1 | 可选 | 游客标识(SDK服务端登录验证接口返回) 1:游客 (其他状态为非游客) 是否必填 - Y |
gid | string | nil | 可选 | 游戏角色Id(暂不支持角色ID包含“~”字符,如包含此字符需反馈给平台), 如果游戏没有角色则传userId,否则通知下线时游戏不知道要踢哪个账号下线 是否必填 - Y |
gameZone | string | nil | 可选 | 区组(暂不支持区组包含“~”字符,如包含此字符需反馈给平台) 是否必填 - N |
notifyUrl | string | nil | 可选 | 通知下线地址 是否必填 - Y |
company | string | "leiting" | 可选 | 运营公司主体 leiting:雷霆(默认) jys:吉游社 demo:DEMO SDK 是否必填 - Y |
token | string | nil | 可选 | 签名 1、参数拼接:age + game + idCard + isFast + KEY(KEY咨询运维,告知运维配置位于:平台配置中心->leiting节点-> api.key.{游戏标识} 配置)2、拼接后的参数计算MD5 3、MD5转小写 是否必填 - Y |
成员方法
函数原型 | 函数作用 |
---|---|
string get_url(string host) | 获取上报地址 |
void sign_by_key(string key) | 签名 |
array request(string host) | 执行上报请求 |
LtAddictionLoginResult
防沉迷登录上报请求结果
成员变量
变量名 | 类型 | 初始值 | 须初始化 | 描述 |
---|---|---|---|---|
onlineTime | int | 0 | 可选 | 在线时长(单位:秒) |
timestamp | int | 0 | 可选 | 当前时间戳(单位:秒) |
limitTime | int | 0 | 可选 | 限制时长(单位:秒) |
usableTime | int | 0 | 可选 | 剩余可用时长(单位:秒) |
isHoliday | int | 2 | 可选 | 是否节假日 1:节假日 2:非节假日 |
成员方法
函数原型 | 函数作用 |
---|---|
bool is_holiday() | 判断是否节假日 |
LtAddictionLogout
继承自 LtClientRequestBase
防沉迷登出上报
成员变量
变量名 | 类型 | 初始值 | 须初始化 | 描述 |
---|---|---|---|---|
company | string | "leiting" | 可选 | 运营公司主体 leiting:雷霆(默认) jys:吉游社 demo:DEMO SDK 是否必填 - Y |
game | string | nil | 可选 | 游戏标识 是否必填 - Y |
gameZone | string | nil | 可选 | 区组(登录上报有传,登出必须传,否则不会踢下线) 是否必填 - N |
gid | string | nil | 可选 | 角色ID(必填,否则不知道登出哪个角色) 是否必填 - Y |
idCard | string | nil | 可选 | 身份唯一标识(登录验证返回) 是否必填 - Y |
token | string | nil | 可选 | 签名 1、参数拼接:game + idCard + KEY(KEY咨询运维,告知运维配置位于:平台配置中心->leiting节点-> api.key.{游戏标识} 配置)2、拼接后的参数计算MD5 3、MD5转小写 是否必填 - Y |
成员方法
函数原型 | 函数作用 |
---|---|
string get_url(string host) | 获取上报地址 |
void sign_by_key(string key) | 签名 |
array request(string host) | 执行上报请求 |
LtAddictionLogoutResult
防沉迷上报结果
成员变量
变量名 | 类型 | 初始值 | 须初始化 | 描述 |
---|
成员方法
函数原型 | 函数作用 |
---|
LtAddictionLogoutNotify
雷霆平台推送给游戏服务器的登出通知
成员变量
变量名 | 类型 | 初始值 | 须初始化 | 描述 |
---|---|---|---|---|
age | int | 0 | 可选 | 年龄 |
game | string | nil | 可选 | 游戏标识 |
gameZone | string | "" | 可选 | 区组(是否有值取决于登录上报是否有传值) |
gid | string | nil | 可选 | 角色Id(是否有值取决于登录上报是否有传值) |
isFast | int | 1 | 可选 | 游客标识 1:游客 2:非游客 |
isHoliday | int | 2 | 可选 | 是否节假日 1:节假日 2:非节假日 |
onlineTime | int | 0 | 可选 | 在线时长(单位:秒) |
timestamp | int | 0 | 可选 | 当前时间戳(单位:秒) |
token | string | nil | 可选 | 签名 1、参数拼接:age + game + gameZone + isFast + isHoliday + onlineTime + timestamp + type + KEY(KEY咨询运维,告知运维配置位于: 平台配置中心->leiting节点-> api.key.{游戏标识} 配置)2、拼接后的参数计算MD5 3、MD5转小写 |
type | int | 3 | 可选 | 踢下线类型 1:达到在线时长上限 2:限制时间段不允许体验游戏 3:客服踢下线 |
成员方法
函数原型 | 函数作用 |
---|---|
bool check_sign_by_key(string key) | 验证签名有效性 |
bool is_holiday() | 是不是假日 |
bool is_guest() | 是不是游客 |
bool is_kicked_off_by_online_time() | 是不是达到在线时长上限被踢下线 |
bool is_kicked_off_by_game_time() | 是不是限制时间段不允许体验游戏被踢下线 |
bool is_kicked_off_by_gm() | 是不是客服踢下线 |
LtAddictionLogoutNotifyResult
游戏服务器处理下线通知的处理结果
成员变量
变量名 | 类型 | 初始值 | 须初始化 | 描述 |
---|---|---|---|---|
message | string | nil | 可选 | 描述信息 |
status | int | 0 | 可选 | 状态码 0:成功 30001:服务器繁忙 70001:参数缺失 70002:参数校验失败 70003:签名校验失败 70007:平台配置错误 |
成员方法
函数原型 | 函数作用 |
---|---|
void set_ok() | 设置处理结果为成功 |
void set_error_code(int code, string message = nil) | 设置处理结果为失败并设置错误码以及提示信息 |
void set_error_by_server_busy(string message = nil) | 设置处理结果为服务器繁忙导致的操作失败并设置提示信息 |
void set_error_by_token(string message = nil) | 设置处理结果为签名校验失败导致的操作失败并设置提示信息 |
LtAuthRequest
继承自 LtClientRequestBase
雷霆平台登录验证
成员变量
变量名 | 类型 | 初始值 | 须初始化 | 描述 |
---|---|---|---|---|
userId | string | nil | 可选 | 用户ID,如果接入篝火测试,该字段(会有特殊符号如:=和+)需要encode 是否必填-Y |
game | string | nil | 可选 | 游戏标识(参考:获取SDK配置) 是否必填 - Y |
channelNo | int | -1 | 可选 | 渠道编号(参考:获取SDK配置) 是否必填 - Y |
token | string | nil | 可选 | SDK登录回调的验证token信息 是否必填 - Y |
成员方法
函数原型 | 函数作用 |
---|---|
string get_url(string host) | 获取验证地址 |
array request(string host) | 执行验证请求 |
LtAuthResult
雷霆平台登录验证结果
成员变量
变量名 | 类型 | 初始值 | 须初始化 | 描述 |
---|---|---|---|---|
age | int | 0 | 可选 | 年龄(未实名认证、游客年龄、不提供年龄的渠道值为0) 是否必填 - Y |
auth | int | 2 | 可选 | 实名认证防沉迷状态 0:已实名认证未成年 1:已实名认证成年人 2:未实名认证 是否必填 - Y |
birthDay | string | nil | 可选 | 生日 官方渠道已实名有值,第三方渠道为空值 (数据格式:MMdd eg.0809) 是否必填 - N |
idCard | string | nil | 可选 | 身份标识 是否必填 - Y |
isGuest | int | 1 | 可选 | 游客标识(默认游客) 0:非游客 1:游客 是否必填 - Y |
成员方法
函数原型 | 函数作用 |
---|---|
bool is_auth_juveniles() | 是不是已实名认证未成年 |
bool is_auth_adult() | 是不是已实名认证成年人 |
bool is_unauth() | 是不是未实名认证 |
bool is_guest() | 是不是游客 |
LtChargeOrderNotify
雷霆平台推送给游戏服务器的充值订单通知
成员变量
变量名 | 类型 | 初始值 | 须初始化 | 描述 |
---|---|---|---|---|
currency | string | nil | 可选 | 币种(默认coin渠道币) 是否必填 - Y |
gameCoin | string | nil | 可选 | 游戏币 是否必填 - Y |
gameOrderNo | string | nil | 可选 | 游戏订单号 游戏需要将此字段与游戏订单中的订单号做校验,否则会被盗刷!!! 是否必填 - Y |
message | string | nil | 可选 | 描述 是否必填 - Y |
productId | string | nil | 可选 | 游戏拉起充值时传入的商品id(iOS返回,Android返回"") 游戏需要将此字段与游戏订单中的商品id做校验,否则会被盗刷!!! 是否必填 - Y |
sign | string | nil | 可选 | 签名(见签名规则) 游戏需要使用游戏订单中的数据计算sign并与此字段做校验,否则会被盗刷!!! 是否必填 - Y |
status | string | nil | 可选 | 订单状态 success:成功 其他状态:失败 是否必填 - Y |
thirdAmount | string | nil | 可选 | 第三方返回金额(分) 游戏需要将此字段与游戏订单中的金额做校验,否则会被盗刷!!! 是否必填 - Y |
thirdNo | string | nil | 可选 | 第三方订单号(iOS渠道为雷霆订单号) 是否必填 - Y |
channelNo | string | nil | 可选 | 渠道编号 游戏需要将此字段与游戏订单中的渠道编号做校验,否则会被盗刷!!! 是否必填 - Y |
userId | string | nil | 可选 | 手游账号ID 游戏需要将此字段与游戏订单中的userId做校验,否则会被盗刷!!! 是否必填 - Y |
extInfo | string | nil | 可选 | 透传字段,充值成功时原样回传给游戏服务端通知接口 是否必填 - N |
成员方法
函数原型 | 函数作用 |
---|---|
bool check_sign_by_key(string key) | 验证签名有效性 |
bool is_ok() | 检查充值订单状态是否为成功 |
LtChargeReportOrderException
继承自 LtClientRequestBase
上报充值订单异常
成员变量
变量名 | 类型 | 初始值 | 须初始化 | 描述 |
---|---|---|---|---|
channelNo | string | nil | 可选 | 渠道编号 是否必填 - Y |
game | string | nil | 可选 | 游戏标识 是否必填 - Y |
gameOrderNo | string | nil | 可选 | 游戏订单号 是否必填 - Y |
sign | string | nil | 可选 | 签名(见签名规则)违规如下(ltkey值请找平台组提供) MD5(game+ channelNo +gameOrderNo+status+ltkey) 是否 必填 - Y |
ip | string | nil | 可选 | ip白名单校验失败时,需要把异常ip传过来 是否必填 - N |
status | int | 0 | 可选 | 异常代码 9:订单金额不一致 10:productId、transactionId字段为空 11:bid错误 12:productId校验失败 13:transactionId不一致 14:userId不一致 98:白名单异常 99:其他情况 是否必填 - Y |
成员方法
函数原型 | 函数作用 |
---|---|
string get_url(string host) | 获取上报充值订单异常的地址 |
void sign_by_key(string key) | 签名 |
array request(string host) | 执行上报充值订单异常的请求 |
LtClientRequestBase
向雷霆平台发送请求的基础类型
成员变量
变量名 | 类型 | 初始值 | 须初始化 | 描述 |
---|