大梦手游SDK 线下充值对接文档

0. 文档更新

时间	更新内容
2024年02月04日	商品信息接口需要新增返回描述，充值回调需要新支持返利参数

1. 说明

该文档阅读对象为，游戏需要接入线下充值的开发人员。

游戏后端提供HTTP接口用于支持线下网页直接充值到游戏

游戏后端需要提供以下接口

获取区服列表

通过区服获取角色列表

通过角色ID，区服获取玩家可购买商品列表

使用区服，角色ID，商品ID向游戏预下单

支付成功向游戏通知回调发货（携带返利参数） - （复用DODSDK支付回调地址）

2.签名算法

签名算法与KEY同支付回调通知一致

public function CalcDodsdkSign($param_ary){
$dodsdk_sign_key = ""; 
unset($param_ary['sign']);//移除数组中的sign字段
ksort($param_ary);//将数组中的字段排序
$url_param = "";
foreach($param_ary as $key => $val){
	$url_param .= ($key."=".$val."&");
}//使$url_param变成a=1&b=2&的格式
$url_param .= "key=$dodsdk_sign_key";
$cal_sign = strtoupper(md5($url_param));//MD5加密，与sign字段比较
return $cal_sign;		
}

3. 游戏提供接口

1. 获取玩家区服列表

说明：SDK携带SDK UIN请求此接口，返回区服列表

请求方式: HTTP GET

请求示例 https://xxxx/server?uin=123

参数说明

参数	类型	是否可空	参数说明
appid	int	否	游戏APPID，用于多个游戏大区共用同一个接口兼容
uin	int	否	sdk用户标识
ts	int	否	发起请求unix时间戳（秒）
sign	string	否	请求签名

返回示例

{
    "ret": 0,
    "msg": "success",
    "data": [
        {
            "serverName": "1服",
            "serverId": "1"
        },
        {
            "serverName": "2服",
            "serverId": "2"
        }
    ]
}

返回结果:为json串

参数	类型	是否可空	参数说明
ret	int	否	验证结果0成功，其他失败
msg	string	是	验证结果说明
data	array	否	数据域
data.serverName	string	是	区服名称
data.serverId	string	是	区服ID

2. 获取玩家角色列表

说明：SDK携带SDK UIN请求此接口，返回区服列表

请求方式: HTTP GET

请求示例 https://xxxx/role?uin=123&serverId=1

参数说明

参数	类型	是否可空	参数说明
appid	int	否	游戏APPID，用于多个游戏大区共用同一个接口兼容
uin	int	否	sdk用户标识
serverId	string	否	游戏提供的区服ID
ts	int	否	发起请求unix时间戳（秒）
sign	string	否	请求签名

返回示例

{
    "ret": 0,
    "msg": "success",
    "data": [
        {
            "roleName": "asdasdas",
            "roleId": "asdasd"
        },
        {
            "roleName": "asdasd",
            "roleId": "asdasd"
        }
    ]
}

返回结果:为json串

参数	类型	是否可空	参数说明
ret	int	否	验证结果0成功，其他失败
msg	string	是	验证结果说明
data	array	否	数据域
data.roleName	string	否	角色名称
data.roleId	string	否	角色ID

3. 获取玩家可购买商品列表

说明：SDK携带SDK UIN，区服ID,角色ID请求此接口，返回玩家可购买商品列表

请求方式: HTTP GET

请求示例 https://xxxx/product?uin=123&serverId=1&roleId=1231

参数说明

参数	类型	是否可空	参数说明
appid	int	否	游戏APPID，用于多个游戏大区共用同一个接口兼容
uin	int	否	sdk用户标识
serverId	string	否	游戏提供的区服ID
roleId	string	否	游戏提供的角色ID
ts	int	否	发起请求unix时间戳（秒）
sign	string	否	请求签名

返回示例

{
    "ret": 0,
    "msg": "success",
    "data": [
        {
            "productId": "asdasdas",
            "productName": "asdasd",
            "productDesc":"一袋金币",
            "productPrice":"6"，
        },
        {
            "productId": "asdasdas",
            "productName": "asdasd",
            "productDesc":"一袋金币",
            "productPrice":"6",
            
        }
    ]
}

返回结果:为json串

参数	类型	是否可空	参数说明
ret	int	否	验证结果0成功，其他失败
msg	string	是	验证结果说明
data	array	否	数据域
data.productId	string	是	商品ID
data.productName	string	是	商品名称
data.productDesc	string	是	商品内容
data.productPrice	string	是	商品价格（元）

4. 向游戏预下单

说明：玩家选择商品之后向游戏接口提交订单信息，返回订单号用于后续支付结果回调

请求方式: HTTP GET

请求示例 https://xxxx/create-order?uin=123&serverId=1&roleId=1231&productId=123

参数说明

参数	类型	是否可空	参数说明
appid	int	否	游戏APPID，用于多个游戏大区共用同一个接口兼容
uin	int	否	sdk用户标识
serverId	string	否	游戏提供的区服ID
roleId	string	否	游戏提供的角色ID
productId	string	否	玩家购买的商品ID
ts	int	否	发起请求unix时间戳（秒）
sign	string	否	请求签名

返回示例

{
    "ret": 0,
    "msg": "success",
    "data":{
        "orderId":"asdasd"
    }
}

返回结果:为json串

参数	类型	是否可空	参数说明
ret	int	否	验证结果0成功，其他失败
msg	string	是	验证结果说明
data	object	否	数据域
data.orderId	string	是	游戏订单号，用于后续回调标识

5. 支付回调

说明：复用DODSDK支付回调地址，（网页下单很容易被篡改价格，建议判断回调金额和游戏商品金额）

来自网页充值的回调订单参数可能携带返利参数（rebate_type,rebate_amount），发货同时需要发送返利代币，完整参数如下

请求参数：

字段	必选	类型	说明
app_order_id	是	string	游戏方生成的订单
order_id	是	string	sdk侧生成的订单
amount	是	number	金额（元）
order_time	是	int	订单创建时间
product_id	是	int	商品ID int类型，IOS历史遗留可能被强转0
from	否	string	支付来源
rebate_type	否	string	返利参数，返利类型目前固定=3
rebate_amount	否	string	返利参数，返利金额=目前为amount * 10%,需要转为对应代币(开新币)
sign	是	string	加密串

线下充值对接

大梦手游SDK 线下充值对接文档#

0. 文档更新#

1. 说明#

2.签名算法#

3. 游戏提供接口#

1. 获取玩家区服列表#

2. 获取玩家角色列表#

3. 获取玩家可购买商品列表#

4. 向游戏预下单#

5. 支付回调#

大梦手游SDK 线下充值对接文档

0. 文档更新

1. 说明

2.签名算法

3. 游戏提供接口

1. 获取玩家区服列表

2. 获取玩家角色列表

3. 获取玩家可购买商品列表

4. 向游戏预下单

5. 支付回调