Skip to content
项目
群组
代码片段
帮助
当前项目
正在载入...
登录 / 注册
切换导航面板
Z
zw_game_sdk
概览
概览
详情
活动
周期分析
版本库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
统计图
问题
0
议题
0
列表
看板
标记
里程碑
CI / CD
CI / CD
流水线
日程表
维基
Wiki
代码片段
代码片段
成员
成员
折叠边栏
关闭边栏
活动
图像
聊天
创建新问题
提交
问题看板
Open sidebar
zwwl
zw_game_sdk
Commits
4c11a145
提交
4c11a145
authored
2月 02, 2026
作者:
李泽奇
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
h5客服中心文档
上级
c71cbb47
显示空白字符变更
内嵌
并排
正在显示
1 个修改的文件
包含
253 行增加
和
67 行删除
+253
-67
H5_SDK对接说明.md
H5_SDK对接说明.md
+253
-67
没有找到文件。
H5_SDK对接说明.md
浏览文件 @
4c11a145
# H5
SDK 对接文档-v1.0
# H5
SDK 对接文档-v1.0
...
@@ -190,6 +190,36 @@
...
@@ -190,6 +190,36 @@
参数枚举
参数枚举
3.13
[
SDK 种花道具上报(种花游戏专用)
](
#sec3.13
)
接口说明
调用方式
返回参数
示例
3.14
[
SDK 种花道具 H5 领取链接接口(种花游戏专用)
](
#sec3.14
)
接口说明
调用方式
返回参数
示例
3.15
[
SDK 打开客服中心
](
#sec3.15
)
接口说明
调用方式
返回参数
示例
## 1. 接入说明<a name="sec1"></a>
## 1. 接入说明<a name="sec1"></a>
### 1.1 术语表<a name="sec1.1"></a>
### 1.1 术语表<a name="sec1.1"></a>
...
@@ -452,16 +482,16 @@ sequenceDiagram
...
@@ -452,16 +482,16 @@ sequenceDiagram
> **Body:**
> **Body:**
>
>
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------
------------------------------------------------ | :--- | :-------- | :----- | :----
--------------------------------------------------------------------------------------------------- |
> | :------------
| :--- | :-------- | :----- | :
--------------------------------------------------------------------------------------------------- |
> | order | true | Object | - | 订单相关 |
> | order | true | Object | - | 订单相关 |
> |
order_id | true | String | - | 平台订单 ID
|
> |
order_id | true | String | - | 平台订单 ID
|
> |
cp_order_id | true | String | - | 游戏传入的外部订单号,服务器会根据这个订单号生成对应的平台订单号,<br>
请保证每笔订单传入的订单号的唯一性 |
> |
cp_order_id | true | String | - | 游戏传入的外部订单号,服务器会根据这个订单号生成对应的平台订单号,
请保证每笔订单传入的订单号的唯一性 |
> |
product_price | true | String | - | 商品单价(分)
|
> |
product_price | true | String | - | 商品单价(分)
|
> |
amount | true | String | | 商品总价(分)
|
> |
amount | true | String | | 商品总价(分)
|
> |
product_id | true | String | - | 商品 ID
|
> |
product_id | true | String | - | 商品 ID
|
> |
product_cnt | true | String | - | 商品数量
|
> |
product_cnt | true | String | - | 商品数量
|
> |
pay_time | true | Timestamp | - | 支付时间(时间戳,到秒)
|
> |
pay_time | true | Timestamp | - | 支付时间(时间戳,到秒)
|
> |
ext | true | String | - | CP 自定义扩展字段,透传信息
|
> |
ext | true | String | - | CP 自定义扩展字段,透传信息
|
> | game_id | true | String | - | 游戏接入时分配的游戏 ID |
> | game_id | true | String | - | 游戏接入时分配的游戏 ID |
> | player_id | true | String | - | 游戏接入时分配的游戏 ID |
> | player_id | true | String | - | 游戏接入时分配的游戏 ID |
> | sign | true | String | - | 签名(签名规则参照 2.1 签名规则,签名的 key 由 SDK 提供) |
> | sign | true | String | - | 签名(签名规则参照 2.1 签名规则,签名的 key 由 SDK 提供) |
...
@@ -666,23 +696,23 @@ sdk.updateRole(config:Object)
...
@@ -666,23 +696,23 @@ sdk.updateRole(config:Object)
##### 请求参数
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :----------
------------------------------------------------
| :---- | :----- | :----- | :---------------------- |
> | :---------- | :---- | :----- | :----- | :---------------------- |
> | role | true | Object | - | 角色信息 |
> | role | true | Object | - | 角色信息 |
> |
event | true | String | other | 事件类型 |
> | event | true | String | other | 事件类型 |
> |
server_id | true | String | - | 区服 ID |
> | server_id | true | String | - | 区服 ID |
> |
server_name | true | String | - | 区服名称 |
> | server_name | true | String | - | 区服名称 |
> |
cp_role_id | true | String | - | 游戏方角色 ID |
> | cp_role_id | true | String | - | 游戏方角色 ID |
> |
role_name | true | String | - | 游戏角色名称 |
> | role_name | true | String | - | 游戏角色名称 |
> |
role_level | true | Int | - | 角色等级 |
> | role_level | true | Int | - | 角色等级 |
> |
cp_account | false | String | - | cp 账号 |
> | cp_account | false | String | - | cp 账号 |
> |
role_vip | false | Int | 0 | 角色 VIP 等级(赞助等级) |
> | role_vip | false | Int | 0 | 角色 VIP 等级(赞助等级) |
> |
combat_num | false | Int | 0 | 角色战力 |
> | combat_num | false | Int | 0 | 角色战力 |
> |
reiki_num | false | Int | 0 | 角色灵符值 |
> | reiki_num | false | Int | 0 | 角色灵符值 |
> |
online_time | false | Int | 0 | 本次在线时长 |
> | online_time | false | Int | 0 | 本次在线时长 |
> |
attack | false | Int | 0 | 攻击力 |
> | attack | false | Int | 0 | 攻击力 |
> |
profession | false | String | - | 职业 |
> | profession | false | String | - | 职业 |
> |
gang_name | false | String | - | 帮会(行会)名称 |
> | gang_name | false | String | - | 帮会(行会)名称 |
> |
trans_level | false | Int | 0 | 转生等级 |
> | trans_level | false | Int | 0 | 转生等级 |
##### 返回参数
##### 返回参数
...
@@ -740,36 +770,36 @@ zwsdk.createOrder(config:Object)
...
@@ -740,36 +770,36 @@ zwsdk.createOrder(config:Object)
##### 请求参数
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------
------------------------------------------------
| :---- | :----- | :------- | :--------------------------------------------------------------------------------------------------- |
> | :------------ | :---- | :----- | :------- | :--------------------------------------------------------------------------------------------------- |
> | order | true | Object | - | 订单相关 |
> | order | true | Object | - | 订单相关 |
> |
cp_order_id | true | String | - | 游戏传入的外部订单号,服务器会根据这个订单号生成对应的平台订单号,请保证每笔订单传入的订单号的唯一性 |
> | cp_order_id | true | String | - | 游戏传入的外部订单号,服务器会根据这个订单号生成对应的平台订单号,请保证每笔订单传入的订单号的唯一性 |
> |
product_price | true | String | - | 商品价格(单价,单位:分) |
> | product_price | true | String | - | 商品价格(单价,单位:分) |
> |
product_id | true | String | - | 商品 ID |
> | product_id | true | String | - | 商品 ID |
> |
amount | true | String | - | 商品总价(单位:分) |
> | amount | true | String | - | 商品总价(单位:分) |
> |
product_cnt | true | String | - | 商品数量 |
> | product_cnt | true | String | - | 商品数量 |
> |
product_name | true | String | - | 商品名称 |
> | product_name | true | String | - | 商品名称 |
> |
product_desc | true | String | - | 商品描述 |
> | product_desc | true | String | - | 商品描述 |
> |
ext | false | String | "" | CP 自定义扩展字段,透传信息 |
> | ext | false | String | "" | CP 自定义扩展字段,透传信息 |
> | role | true | Object | - | 角色相关 |
> | role | true | Object | - | 角色相关 |
> |
event | true | String | recharge | 充值上传的角色信息 |
> | event | true | String | recharge | 充值上传的角色信息 |
> |
server_id | true | String | "" | 游戏服务器 ID |
> | server_id | true | String | "" | 游戏服务器 ID |
> |
server_name | true | String | "" | 游戏服务器名称 |
> | server_name | true | String | "" | 游戏服务器名称 |
> |
cp_role_id | true | String | "" | 玩家角色 ID |
> | cp_role_id | true | String | "" | 玩家角色 ID |
> |
role_name | true | String | "" | 玩家角色名称 |
> | role_name | true | String | "" | 玩家角色名称 |
> |
role_level | true | String | "0" | 玩家角色等级 |
> | role_level | true | String | "0" | 玩家角色等级 |
> |
role_vip | true | String | "0" | 玩家 VIP 等级 |
> | role_vip | true | String | "0" | 玩家 VIP 等级 |
> |
combat_num | false | Int | 0 | 角色战力 |
> | combat_num | false | Int | 0 | 角色战力 |
> |
online_time | false | Int | 0 | 本次在线时长 |
> | online_time | false | Int | 0 | 本次在线时长 |
##### 返回参数
##### 返回参数
> | 参数 | 类型 | 说明 |
> | 参数 | 类型 | 说明 |
> | :----------
---------------------------------------------------------------------------------------------
| :----- | :------------------------- |
> | :---------- | :----- | :------------------------- |
> | status_code | String | 返回状态 |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
> | msg | String | 返回信息 |
> | data | Object | 用户数据 |
> | data | Object | 用户数据 |
> |
data
| Object | 用户数据 |
> |
data
| Object | 用户数据 |
> |
order_id
| String | 订单 ID,可用于订单状态查询 |
> |
order_id
| String | 订单 ID,可用于订单状态查询 |
##### 示例
##### 示例
...
@@ -816,21 +846,21 @@ sdk.checkOrder(config:Object)
...
@@ -816,21 +846,21 @@ sdk.checkOrder(config:Object)
##### 请求参数
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :-------
------------------------------------------------
| :--- | :----- | :----- | :----------- |
> | :------- | :--- | :----- | :----- | :----------- |
> | order | true | Object | - | 订单相关 |
> | order | true | Object | - | 订单相关 |
> |
order_id | true | String | - | 查询的订单号 |
> | order_id | true | String | - | 查询的订单号 |
##### 返回参数
##### 返回参数
> | 参数 | 类型 | 说明 |
> | 参数 | 类型 | 说明 |
> | :--------------
------------------------------------------------------------------------------------------------
| :----- | :--------------------------------- |
> | :-------------- | :----- | :--------------------------------- |
> | status_code | String | 返回状态 |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
> | msg | String | 返回信息 |
> | data | Object | 用户数据 |
> | data | Object | 用户数据 |
> |
data
| Object | 用户数据 |
> |
data
| Object | 用户数据 |
> |
order_id | String | 订单 ID |
> | order_id | String | 订单 ID |
> |
status | String | 订单状态:待支付,已支付 |
> | status | String | 订单状态:待支付,已支付 |
> |
callback_status | String | 回调状态:待回调,回调成功,回调错误 |
> | callback_status | String | 回调状态:待回调,回调成功,回调错误 |
##### 示例
##### 示例
...
@@ -936,12 +966,12 @@ zwsdk.toRankPage(config:Object)
...
@@ -936,12 +966,12 @@ zwsdk.toRankPage(config:Object)
##### 请求参数
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :----------
------------------------------------------------
| :--- | :----- | :----- | :------------- |
> | :---------- | :--- | :----- | :----- | :------------- |
> | role | true | Object | - | 角色相关 |
> | role | true | Object | - | 角色相关 |
> |
server_id | true | String | "" | 游戏服务器 ID |
> | server_id | true | String | "" | 游戏服务器 ID |
> |
server_name | true | String | "" | 游戏服务器名称 |
> | server_name | true | String | "" | 游戏服务器名称 |
> |
cp_role_id | true | String | "" | 玩家角色 ID |
> | cp_role_id | true | String | "" | 玩家角色 ID |
> |
role_name | true | String | "" | 玩家角色名称 |
> | role_name | true | String | "" | 玩家角色名称 |
##### 示例
##### 示例
...
@@ -974,13 +1004,13 @@ zwsdk.roleEventReport(config:Object)
...
@@ -974,13 +1004,13 @@ zwsdk.roleEventReport(config:Object)
##### 请求参数
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 | |
> | 参数 | 必选 | 类型 | 默认值 | 说明 | |
> | :---------
-------------------------------------------
| :--- | :------------------- | :----- | :------------- | --- |
> | :--------- | :--- | :------------------- | :----- | :------------- | --- |
> | role_name
| true | String | - | 角色名称
|
> | role_name
| true | String | - | 角色名称 |
|
> | cp_role_id
| true | String | - | cp 角色 id
|
> | cp_role_id
| true | String | - | cp 角色 id |
|
> | event
| true | String | - | 事件类型
|
> | event
| true | String | - | 事件类型 |
|
> | qureys
| true | Array[{name, value}] | - | 属性
|
> | qureys
| true | Array[{name, value}] | - | 属性 |
|
> |
name | true | String | - | 属性名(中文)
|
> |
name | true | String | - | 属性名(中文) |
|
> |
value | true | String | - | 属性值
|
> |
value | true | String | - | 属性值 |
|
##### 返回参数
##### 返回参数
...
@@ -1125,7 +1155,7 @@ zwsdk.getAgreement()
...
@@ -1125,7 +1155,7 @@ zwsdk.getAgreement()
type 枚举
type 枚举
> | type | 说明 |
> | type | 说明 |
> | ----
----------- | --------
|
> | ----
| ----------
|
> | 1 | 用户协议 |
> | 1 | 用户协议 |
> | 2 | 防沉迷 |
> | 2 | 防沉迷 |
> | 3 | 联系我们 |
> | 3 | 联系我们 |
...
@@ -1133,3 +1163,159 @@ type 枚举
...
@@ -1133,3 +1163,159 @@ type 枚举
> | 5 | 纠纷处理 |
> | 5 | 纠纷处理 |
> | 6 | 防诈骗说明 |
> | 6 | 防诈骗说明 |
> | 7 | 隐私协议 |
> | 7 | 隐私协议 |
### 3.13 种花道具上报(种花游戏专用)<a name="sec3.13"></a>
---
##### 接口说明
> **\***种花游戏使用鲜花道具时上报使用(注:只有种花游戏接入),返回 Promise 对象
##### 调用方式
```
javascript
zwsdk
.
reportFlower
(
config
:
Object
)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :---------- | :--- | :----- | :----- | :------------------------- |
> | role_name | true | String | '' | 角色名称 |
> | cp_role_id | true | String | '' | 角色名称 |
> | expire_time | true | String | '' | 道具过期时间(秒级时间戳) |
> | prop_id | true | String | '' | 道具 id |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :------- |
> | status_code | Int | 返回状态 |
> | msg | String | 返回信息 |
##### 返回数据样例
```
javascript
{
"status_code"
:
1
,
"msg"
:
"上报成功"
,
}
```
##### sdk 调用示例
```
javascript
zwsdk
.
reportFlower
({
role_name
:
'种花道具上报'
,
cp_role_id
:
'1001_168128004_122'
,
expire_time
:
'1766039631'
,
prop_id
:
'123'
})
.
then
((
res
)
=>
{
// .......
// res.status 返回状态
// res.msg 返回信息
})
.
catch
((
err
)
=>
{})
```
### 3.14 种花道具 H5 领取链接接口(种花游戏专用)<a name="sec3.14"></a>
---
##### 接口说明
> **\***种花游戏使用鲜花道具时使用(注:只有种花游戏接入),返回 Promise 对象
##### 调用方式
```
javascript
zwsdk
.
getFlowerUrl
(
config
:
Object
)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------ | :--- | :----- | :----- | :------ |
> | prop_id | true | String | '' | 道具 id |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :----- | ------ | -------- |
> | status_code | String | | | 返回状态 |
> | msg | String | | | 返回信息 |
> | data | Object | | | 用户数据 |
> | | data | Object | | 用户数据 |
> | | | url | String | 游戏链接 |
##### 返回数据样例
```
javascript
{
"status_code"
:
1
,
"msg"
:
"获取成功"
,
"data"
:
{
"data"
:
{
"url"
:
"http://landingdev.zwwlkj03.top/flowerOrder/index.html?dev=1&pd=LJvH8NHKFH7Jrn0MFKLFt5bHKgVo20Y7J7fHPMl-6Xg%3D&t=2&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ6c2FwaS56d3dsa2owMy50b3AiLCJhdWQiOiJ6c2FwaS56d3dsa2owMy50b3AiLCJpYXQiOjE3Njg0NzY4MjMsImRhdGEiOnsiaWQiOiIzNjI1OTg3MDUiLCJnYW1lX2lkIjoiNDYiLCJwbGF5ZXJfaWQiOiIzMjMzODIyODIifX0.ozbB8UHLtjwBsERIJDArS_zzj233QZNcwcqLplFG9-U#46"
}
},
"extra"
:
{}
}
```
##### sdk 调用示例
```
javascript
zwsdk
.
getFlowerUrl
({
prop_id
:
'123'
})
.
then
((
res
)
=>
{
// .......
// res.status 返回状态
// res.msg 返回信息
// res.data.data: {
// "url": "http://landingdev.zwwlkj03.top/flowerOrder/index.html?dev=1&pd=LJvH8NHKFH7Jrn0MFKLFt5bHKgVo20Y7J7fHPMl-6Xg%3D&t=2&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ6c2FwaS56d3dsa2owMy50b3AiLCJhdWQiOiJ6c2FwaS56d3dsa2owMy50b3AiLCJpYXQiOjE3Njg0NzY4MjMsImRhdGEiOnsiaWQiOiIzNjI1OTg3MDUiLCJnYW1lX2lkIjoiNDYiLCJwbGF5ZXJfaWQiOiIzMjMzODIyODIifX0.ozbB8UHLtjwBsERIJDArS_zzj233QZNcwcqLplFG9-U#46"
// }
})
.
catch
((
err
)
=>
{})
```
### 3.15 打开客服中心<a name="sec3.15"></a>
---
##### 接口说明
> 打开客服中心按钮调用
##### 调用方式
```
javascript
zwsdk
.
toServiceCenter
(
config
:
Object
)
```
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :----- | ------ | -------- |
> | status_code | String | | | 返回状态 |
> | msg | String | | | 返回信息 |
##### 返回数据样例
```
javascript
{
"status_code"
:
1
,
"msg"
:
"ok"
,
}
```
##### sdk 调用示例
```
javascript
zwsdk
.
toServiceCenter
()
```
编写
预览
Markdown
格式
0%
重试
或
添加新文件
添加附件
取消
您添加了
0
人
到此讨论。请谨慎行事。
请先完成此评论的编辑!
取消
请
注册
或者
登录
后发表评论