Skip to content
项目
群组
代码片段
帮助
当前项目
正在载入...
登录 / 注册
切换导航面板
Z
zw_game_sdk
概览
概览
详情
活动
周期分析
版本库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
统计图
问题
0
议题
0
列表
看板
标记
里程碑
CI / CD
CI / CD
流水线
日程表
维基
Wiki
代码片段
代码片段
成员
成员
折叠边栏
关闭边栏
活动
图像
聊天
创建新问题
提交
问题看板
Open sidebar
zwwl
zw_game_sdk
Commits
d934696e
提交
d934696e
authored
2月 04, 2026
作者:
Administrator
浏览文件
操作
浏览文件
下载
差异文件
合并分支 'release' 到 'master'
h5文档 查看合并请求 zwwl/zw_game_sdk!263
上级
860ff7ed
c0ee6ac0
隐藏空白字符变更
内嵌
并排
正在显示
1 个修改的文件
包含
98 行增加
和
89 行删除
+98
-89
H5_SDK对接说明.md
H5_SDK对接说明.md
+98
-89
没有找到文件。
H5_SDK对接说明.md
浏览文件 @
d934696e
# H5
SDK 对接文档-v1.0
# H5
SDK 对接文档-v1.0
...
...
@@ -481,20 +481,22 @@ sequenceDiagram
> **Body:**
>
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------ | :--- | :-------- | :----- | :--------------------------------------------------------------------------------------------------- |
> | order | true | Object | - | 订单相关 |
> | order_id | true | String | - | 平台订单 ID |
> | cp_order_id | true | String | - | 游戏传入的外部订单号，服务器会根据这个订单号生成对应的平台订单号，请保证每笔订单传入的订单号的唯一性 |
> | product_price | true | String | - | 商品单价(分) |
> | amount | true | String | | 商品总价(分) |
> | product_id | true | String | - | 商品 ID |
> | product_cnt | true | String | - | 商品数量 |
> | pay_time | true | Timestamp | - | 支付时间（时间戳,到秒） |
> | ext | true | String | - | CP 自定义扩展字段，透传信息 |
> | game_id | true | String | - | 游戏接入时分配的游戏 ID |
> | player_id | true | String | - | 游戏接入时分配的游戏 ID |
> | sign | true | String | - | 签名（签名规则参照 2.1 签名规则，签名的 key 由 SDK 提供） |
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------------------------------------------------------ | :--- | :-------- | :----- | :------------------------------------------------------------------------------------------------------- |
> | order | true | Object | - | 订单相关 |
> | order_id | true | String | - | 平台订单 ID |
> | cp_order_id | true | String | - | 游戏传入的外部订单号，服务器会根据这个订单号生成对应的平台订单号,<br>请保证每笔订单传入的订单号的唯一性 |
> | product_price | true | String | - | 商品单价(分) |
> | amount | true | String | | 商品总价(分) |
> | product_id | true | String | - | 商品 ID |
> | product_cnt | true | String | - | 商品数量 |
> | pay_time | true | Timestamp | - | 支付时间（时间戳,到秒） |
> | ext | true | String | - | CP 自定义扩展字段，透传信息 |
> | game_id | true | String | - | 游戏接入时分配的游戏 ID |
> | player_id | true | String | - | 游戏接入时分配的游戏 ID |
> | sign | true | String | - | 签名（签名规则参照 2.1 签名规则，签名的 key 由 SDK 提供） |
##### 返回参数
...
...
@@ -704,24 +706,25 @@ sdk.updateRole(config:Object)
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :---------- | :---- | :----- | :----- | :---------------------- |
> | role | true | Object | - | 角色信息 |
> | 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 | 转生等级 |
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :---------------------------------------------------------- | :---- | :----- | :----- | :---------------------- |
> | role | true | Object | - | 角色信息 |
> | 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 | 转生等级 |
##### 返回参数
...
...
@@ -778,37 +781,39 @@ zwsdk.createOrder(config:Object)
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------ | :---- | :----- | :------- | :--------------------------------------------------------------------------------------------------- |
> | order | true | Object | - | 订单相关 |
> | cp_order_id | true | String | - | 游戏传入的外部订单号，服务器会根据这个订单号生成对应的平台订单号，请保证每笔订单传入的订单号的唯一性 |
> | product_price | true | String | - | 商品价格（单价，单位：分） |
> | product_id | true | String | - | 商品 ID |
> | amount | true | String | - | 商品总价（单位：分） |
> | product_cnt | true | String | - | 商品数量 |
> | product_name | true | String | - | 商品名称 |
> | product_desc | true | String | - | 商品描述 |
> | ext | false | String | "" | CP 自定义扩展字段，透传信息 |
> | role | true | Object | - | 角色相关 |
> | event | true | String | recharge | 充值上传的角色信息 |
> | server_id | true | String | "" | 游戏服务器 ID |
> | server_name | true | String | "" | 游戏服务器名称 |
> | cp_role_id | true | String | "" | 玩家角色 ID |
> | role_name | true | String | "" | 玩家角色名称 |
> | role_level | true | String | "0" | 玩家角色等级 |
> | role_vip | true | String | "0" | 玩家 VIP 等级 |
> | combat_num | false | Int | 0 | 角色战力 |
> | online_time | false | Int | 0 | 本次在线时长 |
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------------------------------------------------------ | :---- | :----- | :------- | :--------------------------------------------------------------------------------------------------- |
> | order | true | Object | - | 订单相关 |
> | cp_order_id | true | String | - | 游戏传入的外部订单号，服务器会根据这个订单号生成对应的平台订单号，请保证每笔订单传入的订单号的唯一性 |
> | product_price | true | String | - | 商品价格（单价，单位：分） |
> | product_id | true | String | - | 商品 ID |
> | amount | true | String | - | 商品总价（单位：分） |
> | product_cnt | true | String | - | 商品数量 |
> | product_name | true | String | - | 商品名称 |
> | product_desc | true | String | - | 商品描述 |
> | ext | false | String | "" | CP 自定义扩展字段，透传信息 |
> | role | true | Object | - | 角色相关 |
> | event | true | String | recharge | 充值上传的角色信息 |
> | server_id | true | String | "" | 游戏服务器 ID |
> | server_name | true | String | "" | 游戏服务器名称 |
> | cp_role_id | true | String | "" | 玩家角色 ID |
> | role_name | true | String | "" | 玩家角色名称 |
> | role_level | true | String | "0" | 玩家角色等级 |
> | role_vip | true | String | "0" | 玩家 VIP 等级 |
> | combat_num | false | Int | 0 | 角色战力 |
> | online_time | false | Int | 0 | 本次在线时长 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :------------------------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
> | data | Object | 用户数据 |
> | data | Object | 用户数据 |
> | order_id | String | 订单 ID,可用于订单状态查询 |
> | 参数 | 类型 | 说明 |
> | :------------------------------------------------------------------------------------------------------- | :----- | :------------------------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
> | data | Object | 用户数据 |
> | data | Object | 用户数据 |
> | order_id | String | 订单 ID,可用于订单状态查询 |
##### 示例
...
...
@@ -854,22 +859,24 @@ sdk.checkOrder(config:Object)
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------- | :--- | :----- | :----- | :----------- |
> | order | true | Object | - | 订单相关 |
> | order_id | true | String | - | 查询的订单号 |
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------------------------------------------------- | :--- | :----- | :----- | :----------- |
> | order | true | Object | - | 订单相关 |
> | order_id | true | String | - | 查询的订单号 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :-------------- | :----- | :--------------------------------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
> | data | Object | 用户数据 |
> | data | Object | 用户数据 |
> | order_id | String | 订单 ID |
> | status | String | 订单状态：待支付,已支付 |
> | callback_status | String | 回调状态：待回调,回调成功,回调错误 |
> | 参数 | 类型 | 说明 |
> | :-------------------------------------------------------------------------------------------------------------- | :----- | :--------------------------------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
> | data | Object | 用户数据 |
> | data | Object | 用户数据 |
> | order_id | String | 订单 ID |
> | status | String | 订单状态：待支付,已支付 |
> | callback_status | String | 回调状态：待回调,回调成功,回调错误 |
##### 示例
...
...
@@ -974,13 +981,14 @@ zwsdk.toRankPage(config:Object)
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :---------- | :--- | :----- | :----- | :------------- |
> | role | true | Object | - | 角色相关 |
> | server_id | true | String | "" | 游戏服务器 ID |
> | server_name | true | String | "" | 游戏服务器名称 |
> | cp_role_id | true | String | "" | 玩家角色 ID |
> | role_name | true | String | "" | 玩家角色名称 |
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :---------------------------------------------------------- | :--- | :----- | :----- | :------------- |
> | role | true | Object | - | 角色相关 |
> | server_id | true | String | "" | 游戏服务器 ID |
> | server_name | true | String | "" | 游戏服务器名称 |
> | cp_role_id | true | String | "" | 玩家角色 ID |
> | role_name | true | String | "" | 玩家角色名称 |
##### 示例
...
...
@@ -1012,14 +1020,15 @@ zwsdk.roleEventReport(config:Object)
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 | |
> | :--------- | :--- | :------------------- | :----- | :------------- | --- |
> | role_name | true | String | - | 角色名称 | |
> | cp_role_id | true | String | - | cp 角色 id | |
> | event | true | String | - | 事件类型 | |
> | qureys | true | Array[{name, value}] | - | 属性 | |
> | name | true | String | - | 属性名（中文） | |
> | value | true | String | - | 属性值 | |
> | 参数 | 必选 | 类型 | 默认值 | 说明 | |
> | :---------------------------------------------------- | :--- | :------------------- | :----- | :------------- | --- |
> | role_name | true | String | - | 角色名称 |
> | cp_role_id | true | String | - | cp 角色 id |
> | event | true | String | - | 事件类型 |
> | qureys | true | Array[{name, value}] | - | 属性 |
> | name | true | String | - | 属性名（中文） |
> | value | true | String | - | 属性值 |
##### 返回参数
...
...
编写
预览
Markdown
格式
0%
重试
或
添加新文件
添加附件
取消
您添加了
0
人
到此讨论。请谨慎行事。
请先完成此评论的编辑！
取消
请
注册
或者
登录
后发表评论
