Skip to content

Z
zw_game_sdk
提交 7df17331 作者: 张伟乐
操作

整合接口文档

上级 14590898
正在显示 包含 205 行增加 和 9 行删除
第三方接口文档.md
* 加密方式
# 第三方接口说明
* 加密方式
1. POST请求 JSON数据结构
2. Header数据需要加验证参数 Authorization
3. 生成Authorization见文档详情
* [发送邮件模块接口](https://git.wozhangwan.com/zwwl/zw_game_sdk/blob/master/%E5%8F%91%E9%80%81%E9%82%AE%E4%BB%B6%E6%8E%A5%E5%8F%A3.md)
* [合区区服信息上报接口](https://git.wozhangwan.com/zwwl/zw_game_sdk/blob/master/%E5%90%88%E6%9C%8D%E5%8C%BA%E6%9C%8D%E4%BF%A1%E6%81%AF%E4%B8%8A%E6%8A%A5.md)
* [封禁玩家模块接口](https://git.wozhangwan.com/zwwl/zw_game_sdk/blob/master/%E8%B4%A6%E5%8F%B7%E5%B0%81%E7%A6%81%E6%8E%A5%E5%8F%A3.md)
# 第三方接口说明
### 目录
      [签名规则1](#sigin1)
        1.1 [发送邮件模块](#sec1.1)
        1.2 [合区区服信息上报模块](#sec1.2)
        1.3 [禁言角色接口](#sec1.3)
        1.4 [解封角色禁言接口](#sec1.3)
        1.5 [封角色、 账号 接口](#sec1.3)
        1.6 [解封角色、 账号 接口](#sec1.3)
        1.7 [跨服活动抓取模块](#sec1.4)
##### 签名规则1<a name="sigin1"></a>
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.1 发送邮件模块 <a name="sec1.1"></a>
打通掌游和游戏之间，发送邮件功能
请求数据
| 字段 | 是否必传 | 字段类型 | | |
|--------------|------|-----------|--------------------------| ---- |
| email_type | 是 | int | 邮件类型 ： 1 个人邮件 2 全服邮件 | |
| platform | 是 | int | 平台 | |
| main_game_id | 是 | Int | 主游戏ID | |
| title | 是 | String | 标题 | |
| send_user | 是 | String | 发送人（指定为管理员） | |
| content | 是 | String | 内容 | |
| send_time | 是 | datetime | 发送时间 | |
| server_id | 是 | string | 原始区服id | |
| cp_role_id | 否 | string | cp角色id （个人邮件必传） | |
| role_name | 否 | string | 角色名 （个人邮件必传） | |
返回数据
| | 是否必要 | 字段类型 | |
| ---- | -------- | -------- |--------------|
| code | 是 | int | 1 成功 2 失败 |
| msg | 是 | string | 返回信息 ： 发送成功 |
### 1.2 合区区服信息上报模块 <a name="sec1.2"></a>
请求数据
| 字段 | 是否必传 | 字段类型 | | |
|-------------------------|------|-----|-----------------|------|
| merge_server_start_time | 是 | int | 合服开始时间（时间戳精确到秒） | |
| merge_server_end_time | 是 | int | 合服结束时间（时间戳精确到秒） | |
返回数据
| | 是否必要 | 字段类型 | |
|------------------------| -------- | -------- | ------------------------------------------------------------ |
| status_code | 是 | int | 1 成功 2 失败 |
| msg | 是 | string | 返回信息 ： 处理成功 |
| data | 是 | Object[] | |
| data.main_server | 是 | String | 主服 | |
| data.deputy_server | 是 | String | 被合区服 | |
| data.merge_server | 是 | String | 合服后名称 | |
| data.main_game_id | 是 | int | 主游戏ID | |
| data.state | 是 | int | 当前合服状态 | |
| data.server_ids | 是 | String | 原始区服 （原始区服id-名称 逗号链接） 例：46838-无相838区,46842-无相842区 | |
| data.platform | 是 | int | 平台 | |
| data.merge_server_time | 是 | int | 合服时间（时间戳精确到秒） | |
### 1.3 禁言角色接口 <a name="sec1.3"></a>
请求数据
| 字段 | 是否必传 | 字段类型 | | |
| ---------------- | -------- | -------- | ----------------------------------------- | ---- |
| 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 | 返回信息 ： 封禁成功 |
### 1.4 解封角色禁言接口 <a name="sec1.4"></a>
​ 请求数据
​
| 字段 | 是否必传 | 字段类型 | | |
| ----------- | -------- | -------- | ----------------------------------------- | ---- |
| 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 | 返回信息 ： 解封角色禁言成功 |
### 1.5 封角色、 账号 接口 <a name="sec1.5"></a>
请求数据
| 字段 | 是否必传 | 字段类型 | | |
| ----------- | -------- | -------- | ------------------------------------ | ---- |
| 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 | 返回信息 ： 封禁角色成功 |
### 1.6 封角色、 账号 接口 <a name="sec1.5"></a>
​ 请求数据
​
| 字段 | 是否必传 | 字段类型 | | |
| ----------- | -------- | -------- | ------------------------------------ | ---- |
| 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 | 返回信息 ： 解封角色成功 |
### 1.7 跨服活动抓取模块 <a name="sec1.7"></a>
请求数据
| 字段 | 是否必传 | 字段类型 | | |
|----------------|------|-----|------------------------------------------------|------|
| min_start_time | 是 | dateTime | 活动开始时间最小值筛选，筛选start_time字段 2025-10-29 00:00:00 | |
| max_start_time | 是 | dateTime | 活动开始时间最大值筛选，筛选start_time字段 2025-10-29 23:59:59 | |
| page | 是 | int | 页数 | |
| page_size | 是 | int | 每页数据条数 | |
返回数据
| | 是否必要 | 字段类型 | |
|------------------------| -------- | -------- |---------------------------------------------|
| status_code | 是 | int | 1 成功 2 失败 |
| msg | 是 | string | 返回信息 ： 处理成功 |
| data | 是 | Object[] | |
| data.platform | 是 | int | 平台 | |
| data.main_game_id | 是 | int | 主游戏ID | |
| data.group_id | 是 | String | 跨服组id | |
| data.server_id | 是 | Array | 区服ID 数据格式传数组,示例格式:["13000","14000","15000"] | |
| data.name | 是 | String | 活动名称 | |
| data.start_time | 是 | dateTime | 活动开始时间 2025-10-29 09:00:00 | |
| data.end_time | 是 | dateTime | 活动结束时间 2025-10-29 12:00:00 | |
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论