Skip to content
项目
群组
代码片段
帮助
当前项目
正在载入...
登录 / 注册
切换导航面板
Z
zw_game_sdk
概览
概览
详情
活动
周期分析
版本库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
统计图
问题
0
议题
0
列表
看板
标记
里程碑
CI / CD
CI / CD
流水线
日程表
维基
Wiki
代码片段
代码片段
成员
成员
折叠边栏
关闭边栏
活动
图像
聊天
创建新问题
提交
问题看板
Open sidebar
zwwl
zw_game_sdk
Commits
70728a2c
提交
70728a2c
authored
10月 12, 2021
作者:
黄程泽
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
文档
上级
隐藏空白字符变更
内嵌
并排
正在显示
1 个修改的文件
包含
950 行增加
和
0 行删除
+950
-0
SDK对接说明.md
SDK对接说明.md
+950
-0
没有找到文件。
SDK对接说明.md
0 → 100644
浏览文件 @
70728a2c
# 游戏 SDK 对接文档-v1.0
# 游戏 SDK 对接文档-v1.0
### 目录
[
toc
]
## 1. 接入说明
### 1.1 术语表
> | 名称 | 说明 |
> | ---------- | ------------------------------------------------------------ |
> | CP | 游戏研发商。 |
> | SDK | 由平台方提供给游戏研发商，用于游戏接入平台登录，支付。 |
> | SDK服务 | 由平台方开发，用于完成SDK的登录，支付流程，承接游戏服务端的数据。 |
> | 游戏服务 | 游戏研发商开发，为游戏提供服务。 |
> | 小游戏 | 游戏研发方商开发的微信小游戏。 |
> | 支付服务 | 由平台方调用支付服务，包括米大师，微信支付等 |
### 1.2 数据字典
> | 名称 | 说明 |
> | ----------- | ---------------------------------- |
> | member_id | 用户在平台注册账号的唯一标识。 |
> | player_id | 用户在平台的一个游戏中的唯一标识。 |
> | user_token | 用户在平台登录的会话标识。 |
> | game_id | 游戏在平台的唯一标识。 |
> | game_secret | 平台方提供，游戏签名秘钥。 |
> | cp_order_id | 游戏研发商订单唯一标识 |
> | order_id | 平台方提供，订单唯一标识，与cp_order_id一一对应 |
### 1.3 登录流程
```
mermaid
sequenceDiagram
用户->>小游戏: 打开小游戏
小游戏->>SDK: 调用登录
SDK->>SDK服务: 发起登录
SDK服务-->>SDK: member_id,player_id,user_token
SDK-->>小游戏: member_id,player_id,user_token
小游戏->>游戏服务:player_id,user_token
游戏服务->>SDK服务: 登录验证
SDK服务-->>游戏服务: 验证成功
游戏服务-->>小游戏: 登录成功
小游戏-->>用户: 进入游戏
```
### 1.4 充值流程
```
mermaid
sequenceDiagram
用户->>小游戏: 购买商品
小游戏->>SDK: 调用下单，提供cp_order_id
SDK->>SDK服务: 发起下单，cp_order_id
SDK服务-->>SDK: order_id
SDK->>小游戏: 拉起支付
Note over 小游戏 and 用户:等待用户支付
用户->>小游戏: 支付
SDK->>支付服务: 调用支付
loop [支付结果]
SDK->>SDK服务: 查询订单支付状态
end
支付服务->>SDK服务: 支付结果
par 通知小游戏
SDK服务-->>SDK: 订单支付结果
SDK-->小游戏: 订单支付结果
and 通知服务
SDK服务->>游戏服务: 充值结果
游戏服务-->>SDK服务: succes/fail
end
小游戏->>游戏服务: 验证订单
游戏服务-->小游戏: 更新数据
```
## 2. 服务端接入
### 2.1 接口规则
##### 请求域名
> 【HTTPS】zs.wozhangwan.com/api
##### 请求方式
> 【POST】
##### 请求格式
> 【JSON】
##### 返回格式
> 【JSON】
##### 状态说明
| 状态码 | 说明 |
| ------ | -------- |
| 1 | 成功 |
| -1 | 错误 |
| -100 | 未登录 |
| -422 | 参数错误 |
##### 签名规则
> **签名秘钥**
>
> game_secret 为16位字符串，由 SDK 对接时提供，每一个小游戏单独提供一个 game_secret
> **签名串**
>
> 请求参数（去除sign）通过参数名作升序排序；将排好序的参数与game_secret以一下格式进行字符串拼接(game_secret放在最后)
>
> key1=value1&key2=value2&key3=value3&game_secret=secret
> **签名算法**
>
> 【md5】
>
> sign = md5（签名串）
##### 签名示例
```
php
<php
?
$
gameSecret =
"game_secret"
;
$
body =
["player_id"
=
>
1245, "game_id" => 14];
ksort($body, SORT_REGULAR);
$signStr = http_build_query($body)."
&game_secret=".$gameSecret;
$sign = md5($signStr);
```
### 2.2 登录认证
##### 接口说明
> 小游戏通过 SDK 获得 用户user_token, 游戏服务端需要在用户登录游戏成功后调用登录验证接口，验证user_token是否为有效登录用户会话，SDK 服务端需要通过该接口判断用户是否登录游戏服务 。
>
> 注意：该接口有调用频率限制，建议游戏服务端在完成用户登录后调用该接口；
##### 接口地址
> 【POST】 /mini_sdk/auth/checkLogin
##### 请求参数
> **Headers**:
>
> | 参数 | 必选 | 参数值 | 说明 |
> | ------------ | ---- | ---------------- | ----------------------------------- |
> | Content-Type | true | application/json | |
> | User-Token | true | | 下游戏登录后由 SDK 返回的user_token |
> **Body**:
>
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | --------- | ---- | ------ | ------ | ---------------------------------- |
> | game_id | true | Int | - | 游戏接入时分配的游戏ID |
> | player_id | true | Int | - | 小游戏登录后由 SDK 返回的player_id |
> | sign | true | String | - | 参数签名 |
##### 返回参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | ----------- | ----- | ------ | ------ | -------------- |
> | status_code | true | Int | - | 状态码 |
> | msg | true | STRING | - | 返回信息 |
> | data | false | OBJECT | [] | 返回数据（空） |
>
##### 请求示例
```
php
<php
?
public
function
checkLogin
(){
$
host =
'https://zs.wozhangwan.com/api'
;
$
checkLoginUrl =
'/mini_sdk/game/checkLogin'
;
$
url =
$host.$checkLoginUrl;
$
gameSecret =
"game_secret"
;
$
body =
["player_id"
=
>
1245, "game_id" => 14];
$userToken = "user_token";
$body["sign"] = makeSign($body, $gameSecret);
$headers = ["Content-Type:application/json","User-Token:".$userToken];
$response = curl_post($url, $body, $hearders);
}
public function makeSign($body, $Secret){
ksort($body, SORT_REGULAR);
$signStr = http_build_query($body)."
&game_secret=".$gameSecret;
return md5($signStr);
}
public function curl_post($url, $body, $headers){
//初始化
$curl = curl_init ( );
//设置抓取的url
curl_setopt ( $curl, CURLOPT_URL , $url);
//设置头文件的信息作为数据流输出
curl_setopt ( $curl, CURLOPT_HEADER , 1 );
//设置获取的信息以文件流的形式返回，而不是直接输出。
curl_setopt ( $curl, CURLOPT_RETURNTRANSFER , 1 );
//设置post方式提交
curl_setopt ( $curl, CURLOPT_POST , 1 );
//设置post参数
curl_setopt ( $curl, CURLOPT_POSTFIELDS , json_encode($body) );
//设置请求头
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
//执行命令
$data = curl_exec ( $curl );
//关闭URL请求
curl_close ( $curl );
//显示获得的数据
return json_decode($data, true);
}
```
### 2.3 角色信息上报
##### 接口说明
> 上报游戏角色信息到 SDK 服务器；
>
> 选接，客户端或者服务端一个端接入即可；
##### 接口地址
> 【POST】/mini_sdk/game/serverReport
##### 请求参数
> **Headers**:
>
> | 参数 | 必选 | 参数值 | 说明 |
> | ------------ | ---- | ---------------- | ---- |
> | Content-Type | true | application/json | |
> | User-Token | | | |
> **Body:**
>
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :---------------------------------------------------------- | :---- | :----- | :----- | :--------------------------------- |
> | player_id | true | Int | - | 游戏接入时分配的游戏ID |
> | game_id | true | Int | - | 小游戏登录后由 SDK 返回的player_id |
> | role | true | Object | - | 角色信息 |
> | event | true | Int | - | 事件类型 |
> | server_id | true | String | - | 区服ID |
> | server_name | true | String | - | 区服名称 |
> | cp_role_id | true | String | - | 游戏方角色ID |
> | role_level | true | Int | - | 角色等级 |
> | role_vip | false | Int | 0 | 角色VIP等级 |
> | combat_num | false | Int | 0 | 角色战力 |
> | online_time | false | Int | 0 | 本次在线时长 |
> | sign | true | String | - | 签名 |
##### 返回参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | ----------- | ---- | ------ | ------ | -------- |
> | status_code | true | Int | - | 状态码 |
> | msg | true | STRING | - | 返回信息 |
> | data | | | | |
##### 请求示例
```
php
<php
?
public
function
report
(){
$
host =
'https://zs.wozhangwan.com/api'
;
$
checkLoginUrl =
'/mini_sdk/role/severReport'
;
$
url =
$host.$checkLoginUrl;
$
gameSecret =
"game_secret"
;
$
body =
["player_id"
=
>
1245,
"game_id" => 14,
"role" =>[
"event" => 1,
"server_id" =>1,
"server_name" => "区服一",
"cp_role_id" => "roleId",
"role_name" => "角色名称",
"role_level" => 11,
"role_vip" => 0,
"combat_num" => 0,
"online_time" => 0,
]];
$userToken = "user_token";
$body["sign"] = makeSign($body, $gameSecret);
$headers = ["Content-Type:application/json","User-Token:".$userToken];
$response = curl_post($url, $body, $hearders);
}
public function makeSign($body, $Secret){
ksort($body, SORT_REGULAR);
$signStr = http_build_query($body)."
&game_secret=".$gameSecret;
return md5($signStr);
}
public function curl_post($url, $body, $headers){
//初始化
$curl = curl_init ( ) ;
//设置抓取的url
curl_setopt ( $curl , CURLOPT_URL , $url) ;
//设置头文件的信息作为数据流输出
curl_setopt ( $curl , CURLOPT_HEADER , 1 ) ;
//设置获取的信息以文件流的形式返回，而不是直接输出。
curl_setopt ( $curl , CURLOPT_RETURNTRANSFER , 1 ) ;
//设置post方式提交
curl_setopt ( $curl , CURLOPT_POST , 1 ) ;
//设置post参数
curl_setopt ( $curl , CURLOPT_POSTFIELDS , json_encode($body) ) ;
//设置请求头
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
//执行命令
$data = curl_exec ( $curl ) ;
//关闭URL请求
curl_close ( $curl ) ;
//显示获得的数据
return json_decode($data, true);
}
```
### 2.4 支付通知
##### 接口说明
> 需要游戏服务端完成该接口，接收平台充值成功的信息
##### 接口地址
> 【POST】充值结果通知地址，由 CP 方提供
##### 通知参数
> **Headers**:
>
> | 参数 | 必选 | 参数值 | 说明 |
> | ------------ | ---- | ---------------- | ---- |
> | Content-Type | true | application/json | |
> | User-Token | | | |
> **Body:**
>
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :----------------------------------------------------------- | :--- | :-------- | :----- | :----------------------------------------------------------- |
> | order | true | Object | - | 订单相关 |
> | order_id | true | String | - | 平台订单ID |
> | cp_order_id | true | String | - | 游戏传入的外部订单号，服务器会根据这个订单号生成对应的平台订单号，<br>请保证每笔订单传入的订单号的唯一性 |
> | product_price | true | String | - | 商品单价(分) |
> | amount | true | Int | | 商品总价(分) |
> | product_id | true | String | - | 商品 ID |
> | product_cnt | true | String | - | 商品数量 |
> | pay_time | true | Timestamp | - | 支付时间（时间戳） |
> | game_id | true | Int | - | 游戏接入时分配的游戏ID |
> | player_id | true | Int | - | 游戏接入时分配的游戏ID |
> | sign | true | String | - | 签名 |
>
##### 返回参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | ----------- | ---- | ------ | ------ | -------- |
> | status_code | true | Int | - | 状态码 |
> | msg | true | STRING | - | 返回信息 |
> | data | | | | |
## 3. 小游戏 SDK 接入
### 3.1 调用 SDK 初始化
---
##### 接口说明
> 请确保在初始化返回成功后，再调用其他 api。
##### 调用方式
```
javascript
const
zwsdk
=
new
zwsdk
(
config
:
Object
)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------ | :--- | :----- | :----- | :----------- |
> | app_id | true | String | - | 小程序 APPID |
> | game_id | true | String | - | 小游戏 ID |
##### 示例
```
javascript
const
zwsdk
=
new
zwsdk
({
app_id
:
'123123123'
,
game_id
:
'123123123'
})
```
### 3.2 调用 SDK 登录
---
##### 接口说明
> **\***接口返回 Promise 对象
> <br>注意：如果需要标识归属渠道，则调用本接口时必须传递 state 参数。
> <br> 小程序可在 wx.getLaunchOptionsSync() 或 wx.getEnterOptionsSync() 获取启动参数中的 query，在 query 参数中携带有 state 信息。
> <br> 小游戏可在 wx.getLaunchOptionsSync() 或 wx.getEnterOptionsSync()或 wx.onShow() 获取启动参数中的 query，在 query 参数中携带有 state 信息。
> <br> state 信息并非一定会携带，所以此字段非必填字段，但是如果获取到此信息，务必通过本接口传递，否则会丢失归属渠道信息。
##### 调用方式
```
javascript
zwsdk
.
login
(
config
:
Object
)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------ | :---- | :------ | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
> | state | true | String | - | 渠道信息 (wx.getEnterOptionsSync() 返回值里 query.state ) |
> | query | true | String | - | 启动小游戏的 query 参数 (需要 JSON.stringify 转成 String) |
> | showLoading | false | Boolean | false | 异步请求中，是否显示微信小程序 loading 提示框 |
> | loadingParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showLoading](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showLoading.html) 参数一致 |
> | showToast | false | Boolean | false | 异步请求失败，是否显示微信小程序消息提示框 <br>异步请求成功，若要显示消息提示，需主动调用微信小程序消息提示框框 |
> | toastParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showToast](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showToast.html) 参数一致 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :----------------------------------------------------------- | :----- | :------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
> | data | Object | 用户数据 |
> | data | Object | 用户数据 |
> | member_id | String | 账号 ID |
> | player_id | String | 玩家 ID |
> | username | String | 账号名 |
> | avatar | String | 头像 |
> | mobile | String | 手机号 |
> | has_identify | String | 是否实名 |
##### 示例
```
javascript
const
{
query
}
=
wx
.
getEnterOptionsSync
()
zwsdk
.
login
({
state
:
query
.
state
||
''
,
query
:
query
})
.
then
((
res
)
=>
{
// .......
// res.status 返回状态
// res.msg 返回信息
// res.data.data 返回数据
})
```
### 3.3 SDK 账号更新
---
##### 接口说明
> **\***接口返回 Promise 对象
> <br> SDK 不主动上传用户信息，若要更新用户信息，需主动调用此接口
##### 调用方式
```
javascript
zwsdk
.
updateUserInfo
(
config
:
Object
)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------- | :---- | :------ | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
> | raw_data | true | String | - | 不包括敏感信息的原始数据字符串，用于计算签名 |
> | signature | true | String | - | 使用 sha1( rawData + sessionkey ) 得到字符串，用于校验用户信息 |
> | encrypted_date | true | String | - | 包括敏感数据在内的完整用户信息的加密数据 |
> | iv | true | String | - | 加密算法的初始向量 |
> | user_info | True | Object | - | wx.getUserInfo 返回值里的 userInfo 字段 |
> | showLoading | false | Boolean | false | 异步请求中，是否显示微信小程序 loading 提示框 |
> | loadingParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showLoading](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showLoading.html) 参数一致 |
> | showToast | false | Boolean | false | 异步请求失败，是否显示微信小程序消息提示框 <br>异步请求成功，若要显示消息提示，需主动调用微信小程序消息提示框框 |
> | toastParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showToast](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showToast.html) 参数一致 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :----------------------------------------------------------- | :----- | :------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
> | data | Object | 用户数据 |
> | data | Object | 用户数据 |
> | member_id | String | 账号 ID |
> | player_id | String | 玩家 ID |
> | username | String | 账号名 |
> | avatar | String | 头像 |
> | mobile | String | 手机号 |
> | has_identify | String | 是否实名 |
> | user_token | String | TOKEN |
##### 示例
```
<button bindgetuserinfo="updateUserInfo" open-type="getUserInfo"> 授权</button>
```
```
javascript
function
updateUserInfo
(
e
)
{
zwsdk
.
updateUserInfo
({
raw_data
:
e
.
detail
.
rawData
,
signature
:
e
.
detail
.
signature
,
encrypted_data
:
e
.
detail
.
encryptedData
,
iv
:
e
.
detail
.
iv
,
user_info
:
e
.
detail
.
userInfo
})
.
then
((
res
)
=>
{
// .......
// res.status 返回状态
// res.msg 返回信息
// res.data.data 返回数据
})
}
// 主动上传用户信息，需先校验用户是否开启授权
wx
.
getSetting
({
success
:
(
res
)
=>
{
if
(
res
.
authSetting
[
'scope.userInfo'
])
{
// 用户当前已授权，则可调用 wx.getUserInfo 获取用户最新个人信息
wx
.
getUserInfo
({
success
:
(
userInfo
)
=>
{
zwsdk
.
updateUserInfo
({
raw_data
:
userInfo
.
rawData
,
signature
:
userInfo
.
signature
,
encrypted_data
:
userInfo
.
encryptedData
,
iv
:
userInfo
.
iv
,
user_info
:
userInfo
.
userInfo
})
}
})
}
}
})
```
### 3.4 SDK 下单
---
##### 接口说明
> **\***接口返回 Promise 对象
>
> 此接口会依据管理后台配置，分二种处理情况：
>
> - 调起米大师支付
> - 调起支付小程序支付
##### 调用方式
```
javascript
zwsdk
.
createOrder
(
config
:
Object
)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------------------------------------------------------ | :---- | :------ | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
> | order | true | Object | - | 订单相关 |
> | cp_order_id | true | String | - | 游戏传入的外部订单号，服务器会根据这个订单号生成对应的平台订单号，请保证每笔订单传入的订单号的唯一性 |
> | product_price | true | String | - | 商品价格（单价，单位：分） |
> | product_id | true | String | - | 商品 ID |
> | amout | true | String | - | 商品总价（单位：分） |
> | product_cnt | true | String | - | 商品数量 |
> | product_name | true | String | - | 商品名称 |
> | product_desc | true | String | - | 商品描述 |
> | ext | true | String | "" | CP 自定义扩展字段，透传信息 |
> | role | true | Object | - | 角色相关 |
> | event | true | String | - | 充值上传的角色信息 |
> | 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 等级 |
> | showLoading | false | Boolean | false | 异步请求中，是否显示微信小程序 loading 提示框 |
> | loadingParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showLoading](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showLoading.html) 参数一致 |
> | showToast | false | Boolean | false | 异步请求失败，是否显示微信小程序消息提示框 <br>异步请求成功，若要显示消息提示，需主动调用微信小程序消息提示框框 |
> | toastParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showToast](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showToast.html) 参数一致 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :----------------------------------------------------------- | :----- | :------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
> | data | Object | 用户数据 |
> | data | Object | 用户数据 |
> | order_id | String | 订单 ID |
##### 示例
```
javascript
zwsdk
.
createOrder
({
order
:
{
cp_order_id
:
'10001'
,
product_price
:
'1'
,
amount
:
'1'
product_id
:
'1000000001'
,
product_cnt
:
'1'
,
product_name
:
'金币'
,
product_desc
:
'金币'
,
ext
:
''
},
role
:
{
event
:
''
,
server_id
:
''
,
server_name
:
''
,
cp_role_id
:
''
,
role_name
:
''
,
role_level
:
'0'
,
role_vip
:
'0'
}
})
.
then
((
res
)
=>
{
// .......
// res.status 返回状态
// res.msg 返回信息
// res.data.data 返回数据
})
```
### 3.5 SDK 查询支付结果
---
##### 接口说明
> **\***接口返回 Promise 对象
##### 调用方式
```
javascript
zwsdk
.
checkOrder
(
config
:
Object
)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------------------------------------------------- | :---- | :------ | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
> | order | true | Object | - | 订单相关 |
> | order_id | true | String | - | 查询的订单号 |
> | showLoading | false | Boolean | false | 异步请求中，是否显示微信小程序 loading 提示框 |
> | loadingParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showLoading](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showLoading.html) 参数一致 |
> | showToast | false | Boolean | false | 异步请求失败，是否显示微信小程序消息提示框 <br>异步请求成功，若要显示消息提示，需主动调用微信小程序消息提示框框 |
> | toastParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showToast](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showToast.html) 参数一致 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :----------------------------------------------------------- | :----- | :------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
> | data | Object | 用户数据 |
> | data | Object | 用户数据 |
> | order_id | String | 订单 ID |
> | status | String | 订单状态 |
> | callback_status | String | 回调状态 |
##### 示例
```
javascript
zwsdk
.
checkOrder
({
order
:
{
order_id
:
'10001'
}
})
.
then
((
res
)
=>
{
// .......
// res.status 返回状态
// res.msg 返回信息
// res.data.data 返回数据
})
```
### 3.6 SDK 获取分享内容
---
##### 接口说明
> **\***接口返回 Promise 对象
##### 调用方式
```
javascript
zwsdk
.
getShareInfo
(
config
:
Object
)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------ | :---- | :------ | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
> | path | true | String | - | 分享路径，路径前不要添加'/'，不得携带参数，空则为小程序主页面 |
> | showLoading | false | Boolean | false | 异步请求中，是否显示微信小程序 loading 提示框 |
> | loadingParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showLoading](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showLoading.html) 参数一致 |
> | showToast | false | Boolean | false | 异步请求失败，是否显示微信小程序消息提示框 <br>异步请求成功，若要显示消息提示，需主动调用微信小程序消息提示框框 |
> | toastParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showToast](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showToast.html) 参数一致 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :----------------------------------------------------------- | :----- | :--------------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
> | data | Object | 用户数据 |
> | data | Object | 用户数据 |
> | share_id | String | 分享 ID |
> | title | String | 分享标题 |
> | path | String | 分享地址(带参数) |
> | image | String | 图片 |
> | qr_code | String | 小程序码 |
> | state | String | 渠道 ID |
##### 示例
```
javascript
zwsdk
.
getShareInfo
({
path
:
'pages/box/box'
})
.
then
((
res
)
=>
{
// .......
// res.status 返回状态
// res.msg 返回信息
// res.data.data 返回数据
})
```
### 3.7 SDK 分享上报
---
##### 接口说明
> **\***接口返回 Promise 对象
> <br>由于[官方接口能力调整](https://developers.weixin.qq.com/community/develop/doc/000eacab888a20e8a2579099754401)，此接口只能统计用户触发分享点击，而非用户成功分享。在用户触发分享操作时调用。
##### 调用方式
```
javascript
zwsdk
.
reportShare
(
config
:
Object
)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------ | :---- | :------ | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
> | share_id | true | String | - | 分享 ID |
> | ext | true | String | - | 分享内容 |
> | showLoading | false | Boolean | false | 异步请求中，是否显示微信小程序 loading 提示框 |
> | loadingParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showLoading](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showLoading.html) 参数一致 |
> | showToast | false | Boolean | false | 异步请求失败，是否显示微信小程序消息提示框 <br>异步请求成功，若要显示消息提示，需主动调用微信小程序消息提示框框 |
> | toastParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showToast](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showToast.html) 参数一致 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
##### 示例
```
javascript
zwsdk
.
reportShare
({
path
:
'pages/box/box'
})
.
then
((
res
)
=>
{
// .......
// res.status 返回状态
// res.msg 返回信息
})
```
### 3.8 SDK 角色上报
---
##### 接口说明
> **\***接口返回 Promise 对象
##### 调用方式
```
javascript
zwsdk
.
updateRole
(
config
:
Object
)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :---------------------------------------------------------- | :---- | :------ | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
> | role | true | String | - | 角色信息 |
> | event | true | String | - | 角色上传事件类型 ID |
> | server_id | true | String | - | 区服 ID ID |
> | server_name | true | String | - | 区服名称 ID |
> | cp_role_id | true | String | - | CP 角色 ID ID |
> | role_level | true | String | - | 角色等级 ID |
> | role_vip | true | String | - | 角色 VIP 等级 ID |
> | combat_num | true | String | - | 角色战力 ID |
> | online_time | true | String | - | 本次在线时长 ID |
> | showLoading | false | Boolean | false | 异步请求中，是否显示微信小程序 loading 提示框 |
> | loadingParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showLoading](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showLoading.html) 参数一致 |
> | showToast | false | Boolean | false | 异步请求失败，是否显示微信小程序消息提示框 <br>异步请求成功，若要显示消息提示，需主动调用微信小程序消息提示框框 |
> | toastParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showToast](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showToast.html) 参数一致 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
##### 示例
```
javascript
zwsdk
.
updateRole
({
role
:
{
event
:
'1'
,
server_id
:
'10001'
,
server_name
:
'一区'
,
cp_role_id
:
'1000005'
,
role_level
:
'140'
,
role_vip
:
'7'
,
combat_num
:
'1500000'
,
online_time
:
'0'
}
})
.
then
((
res
)
=>
{
// .......
// res.status 返回状态
// res.msg 返回信息
})
```
### 3.9 SDK 敏感词监测
---
##### 接口说明
> **\***接口返回 Promise 对象
##### 调用方式
```
javascript
zwsdk
.
checkMsg
(
config
:
Object
)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------ | :---- | :------ | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
> | content | true | String | - | 用于检测的字符串 |
> | showLoading | false | Boolean | false | 异步请求中，是否显示微信小程序 loading 提示框 |
> | loadingParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showLoading](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showLoading.html) 参数一致 |
> | showToast | false | Boolean | false | 异步请求失败，是否显示微信小程序消息提示框 <br>异步请求成功，若要显示消息提示，需主动调用微信小程序消息提示框框 |
> | toastParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showToast](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showToast.html) 参数一致 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
##### 示例
```
javascript
zwsdk
.
checkMsg
({
content
:
'中华人民共和国万岁!'
})
.
then
((
res
)
=>
{
// .......
// res.status 返回状态
// res.msg 返回信息
})
```
### 3.10 SDK 敏感图片监测
---
##### 接口说明
> **\***接口返回 Promise 对象
##### 调用方式
```
javascript
zwsdk
.
checkImg
(
config
:
Object
)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------ | :---- | :------ | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
> | filePath | true | String | - | 用于检测的图片链接 |
> | showLoading | false | Boolean | false | 异步请求中，是否显示微信小程序 loading 提示框 |
> | loadingParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showLoading](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showLoading.html) 参数一致 |
> | showToast | false | Boolean | false | 异步请求失败，是否显示微信小程序消息提示框 <br>异步请求成功，若要显示消息提示，需主动调用微信小程序消息提示框框 |
> | toastParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showToast](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showToast.html) 参数一致 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
##### 示例
```
javascript
wx
.
chooseImage
({
count
:
1
,
success
:
(
res
)
=>
{
zwsdk
.
checkImg
({
filePath
:
res
.
tempFilePaths
[
0
]
})
.
then
((
res
)
=>
{
// .......
// res.status 返回状态
// res.msg 返回信息
})
}
})
```
编写
预览
Markdown
格式
0%
重试
或
添加新文件
添加附件
取消
您添加了
0
人
到此讨论。请谨慎行事。
请先完成此评论的编辑！
取消
请
注册
或者
登录
后发表评论
