Skip to content

Z
zw_game_sdk
提交 79d0df5e 作者: 陈晨
操作

fix conflicts

上级 cbd88954 dcda7aff
正在显示 包含 332 行增加 和 63 行删除
iOSSDK对接说明文档.md
## ZYouSDK V1.0.0文档接入使用
## ZYouSDK V1.0.0文档接入使用
......@@ -284,6 +284,7 @@ app启动时调用注册sdk
@"cp_role_id":@"1314900", //CP角色ID
@"role_name":@"test_name", //角色名称
@"role_level":@"100", //角色等级
@"cp_account":@"7", //cp账号
@"role_vip":@"7", //角色VIP等级
@"combat_num":@"1000", //角色战力
@"online_time":@"10", //本次在线时长
......@@ -305,32 +306,37 @@ app启动时调用注册sdk
```
#### 参数字段说明<a name="sec8.3"></a>
| 名称 | 类型 | 是否必须| 默认值 |说明 |
|:--------| -------------:| -------------------:|-------------:|-------------:|
| role{} | object | 必须 | | 角色信息 |
| event | String | 必须 |other |事件类型，online: 角色登录, create: 创建角色,level_up: 提升等级,offline: 角色退出,other: 其他,delete: 删除角色 |
| server_id | string | 必须 |0 | 区服ID |
| server_name | string | 必须 |"" | 区服名称 |
| cp_role_id |string | 必须 |"" | CP角色ID |
| role_name | string | 必须 |"" | 角色名称 |
| role_level | number | 必须 | 0| 角色等级 |
| role_vip | number | 必须 |0| 角色VIP等级 |
| combat_num | number | 必须 |0 | 角色战力 |
| reiki_num | String | 必须 | "0"| 角色灵符值|
| online_time | number | 必须 | 0| 本次在线时长 |
| attack | number | 必须 |0| 攻击力 |
| profession | string | 必须 |""| 职业 |
| game_name | string | 必须 |"" |帮会(行会)名称 |
| trans_level | string | 必须 | 0| 转生等级 |
| sponsor_level | string | 必须 |0 | 赞助等级/会员等级 |
| reiki_num | number | 必须 |0 | 灵符值 默认0 |
| power | string | 必须 | "" | 国家 |
| main_city_level | number | 必须 |0 | 官邸等级 |
| chapter_index | number | 必须 |0 | 章节等级 |
| 参数 | 必选 | 类型 | 默认值 | 说明 |
| :----------------------------------------------------------- | :---- | :----- | :----- | :---------------- |
| event | true | String | other | 事件类型 |
| server_id | true | String | - | 区服ID |
| server_name | true | String | - | 区服名称 |
| cp_role_id | true | String | - | 游戏方角色ID |
| role_name | true | String | - | 游戏角色名称 |
| role_level | true | Int | - | 角色等级 |
| cp_account | false | String | - | cp账号 |
| role_vip | false | Int | 0 | 角色VIP等级(赞助等级) |
| combat_num | false | Int | 0 | 角色战力 |
| reiki_num | false | Int | 0 | 角色灵符值 |
| online_time | false | Int | 0 | 本次在线时长 |
| attack | false | Int | 0 | 攻击力 |
| profession | false | String | - | 职业 |
| gang_name | false | String | - | 帮会(行会)名称 |
| trans_level | false | Int | 0 | 转生等级 |
事件类型event
| EVENT | 说明 |
| -------- | -------- |
| create | 创建角色 |
| online | 角色上线 |
| offline | 角色下线 |
| level_up | 角色升级 |
| delete | 删除角色 |
| recharge | 角色充值 |
| other | 其他 |
### 9、退出登录<a name="sec9"></a>
......@@ -371,7 +377,7 @@ app启动时调用注册sdk
>
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | --------- | ---- | ------ | ------ | ---------------------------------- |
> | game_id | true | Int | - | 游戏接入时分配的游戏ID |
> | game_id | true | Int | - | 游戏接入时分配的游戏ID(建议从user_token中取，#后面的数字即为game_id)|
> | player_id | true | Int | - | 小游戏登录后由 SDK 返回的player_id |
> | sign | true | String | - | 参数签名 |
......
iossdk_appstore对接说明文档.md
## ZYouSDK V1.0.0文档接入使用
## ZYouSDK V1.0.0文档接入使用
......@@ -83,6 +83,7 @@
&nbsp;&nbsp; 3.9、Xcode添加白名单
&nbsp;&nbsp; 在 Info.plist 中添加 LSApplicationQueriesSchemes 类型 Array
&nbsp;&nbsp; 在LSApplicationQueriesSchemes下添加以下白名单
```
weixin
wechat
......@@ -106,7 +107,7 @@ app启动时调用注册sdk
```
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// Override point for customization after application launch.
[[ZYouManager shareInstance]zy_registerGame];
[[ZYouManager shareInstance]zy_registerGameWithApplication:application options:launchOptions];
return YES;
}
......@@ -294,6 +295,7 @@ app启动时调用注册sdk
@"role_name":@"test_name", //角色名称
@"role_level":@"100", //角色等级
@"role_vip":@"7", //角色VIP等级
@"cp_account":@"7", //cp账号
@"combat_num":@"1000", //角色战力
@"online_time":@"10", //本次在线时长
@"attack":@"2000", //攻击力
......@@ -317,29 +319,37 @@ app启动时调用注册sdk
#### 参数字段说明<a name="sec8.3"></a>
| 名称 | 类型 | 是否必须| 默认值 |说明 |
|:--------| -------------:| -------------------:|-------------:|-------------:|
| role{} | object | 必须 | | 角色信息 |
| event | String | 必须 |other |事件类型，online: 角色登录, create: 创建角色,level_up: 提升等级,offline: 角色退出,other: 其他,delete: 删除角色 |
| server_id | string | 必须 |0 | 区服ID |
| server_name | string | 必须 |"" | 区服名称 |
| cp_role_id |string | 必须 |"" | CP角色ID |
| role_name | string | 必须 |"" | 角色名称 |
| role_level | number | 必须 | 0| 角色等级 |
| role_vip | number | 必须 |0| 角色VIP等级 |
| combat_num | number | 必须 |0 | 角色战力 |
| reiki_num | String | 必须 | "0"| 角色灵符值|
| online_time | number | 必须 | 0| 本次在线时长 |
| attack | number | 必须 |0| 攻击力 |
| profession | string | 必须 |""| 职业 |
| game_name | string | 必须 |"" |帮会(行会)名称 |
| trans_level | string | 必须 | 0| 转生等级 |
| sponsor_level | string | 必须 |0 | 赞助等级/会员等级 |
| reiki_num | number | 必须 |0 | 灵符值 默认0 |
| power | string | 必须 | "" | 国家 |
| main_city_level | number | 必须 |0 | 官邸等级 |
| chapter_index | number | 必须 |0 | 章节等级 |
| 参数 | 必选 | 类型 | 默认值 | 说明 |
| :----------------------------------------------------------- | :---- | :----- | :----- | :---------------- |
| role | true | Object | - | 角色信息 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;event | true | String | other | 事件类型 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;server_id | true | String | - | 区服ID |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;server_name | true | String | - | 区服名称 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cp_role_id | true | String | - | 游戏方角色ID |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;role_name | true | String | - | 游戏角色名称 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;role_level | true | Int | - | 角色等级 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cp_account | false | String | - | cp账号 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;role_vip | false | Int | 0 | 角色VIP等级 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;combat_num | false | String | "0" | 角色战力 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;reiki_num | false | Int | 0 | 角色灵符值 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;online_time | false | Int | 0 | 本次在线时长 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;attack | false | Int | 0 | 攻击力 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;profession | false | String | - | 职业 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;gang_name | false | String | - | 帮会(行会)名称 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;trans_level | false | Int | 0 | 转生等级 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sponsor_level | false | Int | 0 | 赞助等级/会员等级 |
事件类型event
| EVENT | 说明 |
| -------- | -------- |
| create | 创建角色 |
| online | 角色上线 |
| offline | 角色下线 |
| level_up | 角色升级 |
| delete | 删除角色 |
| recharge | 角色充值 |
| other | 其他 |
### 9、退出登录<a name="sec9"></a>
......@@ -380,7 +390,7 @@ app启动时调用注册sdk
>
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | --------- | ---- | ------ | ------ | ---------------------------------- |
> | game_id | true | Int | - | 游戏接入时分配的游戏ID |
> | game_id | true | Int | - | 游戏接入时分配的游戏ID(建议从user_token中取，#后面的数字即为game_id)|
> | player_id | true | Int | - | 小游戏登录后由 SDK 返回的player_id |
> | sign | true | String | - | 参数签名 |
......
账号封禁接口.md 0 → 100644
v1.0
v1.0
## 封禁玩家模块接口
打通掌游和游戏之间，账号违规管理： 封账号 封角色 禁言
### 请求方式
1. POST 数据结构 JSON
2. Header数据需要加验证参数 Authorization
3. Authorization 将请求数据，
a. 按照key ascll 码小到大排序,
b.拼接参数 string = "key1=value1&key2=value2"
c. 将string 转为32 位的md5数据， stringMd5 = string.md5();
d. 截取stringMd5 第二位到第17位， 一共 16位字符串, 之后转为大写， 为Authorization
#### 1. 禁言角色接口
请求数据
| 字段 | 是否必传 | 字段类型 | | |
| ---------------- | -------- | -------- | ----------------------------------------- | ---- |
| banned_type | 是 | int | 封禁方式 ： 1 禁言角色 3 静默禁言 | |
| banned_time_type | 是 | Int | 封禁时间类型 ： 1 小时 2 天 3 永久封禁 | |
| banned_time | 是 | Int | 封禁时间值： 例如 1 0 | |
| cp_role_id | 是 | String | 角色ID | |
| server_id | 是 | String | 角色注册区服ID | |
| game_id | 否 | int | 创角游戏ID | |
| zw_number | 是 | int | 1 2 3 4 例如掌玩1 | |
| player_id | 是 | string | 登录账号返回信息 唯一信息 确定账号 | |
返回数据
| | 是否必要 | 字段类型 | |
| ---- | -------- | -------- | --------------------- |
| code | 是 | int | 1 成功 2 失败 |
| msg | 是 | string | 返回信息 ： 封禁成功 |
#### 2.解封角色禁言接口
​ 请求数据
​
| 字段 | 是否必传 | 字段类型 | | |
| ----------- | -------- | -------- | ----------------------------------------- | ---- |
| cp_role_id | 是 | String | 角色ID | |
| game_id | 否 | int | 创角游戏ID | |
| zw_number | 是 | int | 1 2 3 4 例如掌玩1 | |
| banned_type | 是 | int | 封禁方式 ： 1 禁言角色 3 静默禁言 | |
| server_id | 是 | String | 角色注册区服ID | |
| player_id | 是 | string | 登录账号返回信息 唯一信息 确定账号 | |
返回数据
| | 是否必要 | 字段类型 | |
| ---- | -------- | -------- | ----------------------------- |
| code | 是 | int | 1 成功 2 失败 |
| msg | 是 | string | 返回信息 ： 解封角色禁言成功 |
#### 3.封角色、 账号 接口
请求数据
| 字段 | 是否必传 | 字段类型 | | |
| ----------- | -------- | -------- | ------------------------------------ | ---- |
| cp_role_id | 是 | String | 角色ID | |
| banned_type | 是 | int | 1 封角色 2 封账号 默认封角色 | |
| server_id | 是 | String | 角色注册区服ID | |
| game_id | 否 | int | 创角游戏ID | |
| zw_number | 是 | int | 1 2 3 4 例如掌玩1 | |
| player_id | 是 | string | 登录账号返回信息 唯一信息 确定账号 | |
返回数据
| | 是否必要 | 字段类型 | |
| ---- | -------- | -------- | ------------------------- |
| code | 是 | int | 1 成功 2 失败 |
| msg | 是 | string | 返回信息 ： 封禁角色成功 |
#### 4.解封角色、 账号 接口
​ 请求数据
​
| 字段 | 是否必传 | 字段类型 | | |
| ----------- | -------- | -------- | ------------------------------------ | ---- |
| cp_role_id | 是 | String | 角色ID | |
| banned_type | 是 | int | 1 封角色 2 封账号 默认封角色 | |
| game_id | 否 | int | 创角游戏ID | |
| zw_number | 是 | int | 1 2 3 4 例如掌玩1 | |
| server_id | 是 | String | 角色注册区服ID | |
| player_id | 是 | string | 登录账号返回信息 唯一信息 确定账号 | |
返回数据
| | 是否必要 | 字段类型 | |
| ---- | -------- | -------- | ------------------------- |
| code | 是 | int | 1 成功 2 失败 |
| msg | 是 | string | 返回信息 ： 解封角色成功 |
\ No newline at end of file
风控聊天内容接口.md 0 → 100644
v1.0
v1.0
## 聊天记录风控接口
接受风控数据
### 请求方式
1. POST 数据结构 JSON
2. Header数据需要加验证参数 Authorization
3. Authorization 将请求数据，
a. 按照key ascll 码小到大排序,
b.拼接参数 string = "key1=value1&key2=value2" + secert;
c. 将string 转为32 位的md5数据， stringMd5 = string.md5();
d. 截取stringMd5 第二位到第17位， 一共 16位字符串, 之后转为大写， 为Authorization
#### 1. 聊天记录风控接口
/api/server/chat/rickReport
请求数据
| 字段 | 是否必传 | 字段类型 | | |
| ---------------- | -------- | -------- | ----------------------------------------- | ---- |
| main_game_name | 是 | String | 主游戏名称 | |
| cp_role_id | 是 | String | 角色ID | |
| server_id | 是 | String | 区服ID | |
| cp_account | 是 | String | 用户ID | |
| action_time | 是 | dateTime | 发送时间 | |
| content | 是 | String | 聊天内容 | |
| context | 否 | String | 上下文检索 | |
| risk_text | 否 | String | 风控类型 | |
| handle_text | 否 | String | 处理结果 | |
返回数据
| | 是否必要 | 字段类型 | |
| ---- | -------- | -------- | --------------------- |
| code | 是 | int | 1 成功 2 失败 |
| msg | 是 | string | 返回信息 ： 处理成功 |
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论