Jun

服务端接口文档(不常用功能)

wapublisher No Comment

Uncategorized

一、消息推送

1.1 消息推送接口

接口说明：

接口相关	说明
接口提供方	WA平台
接口调用方	CP
接口实现方式	HTTP/POST
接口描述	可通过该接口发起推送任务，需要在sdk后台配置IP白名单后,才能正常访问此接口
生产环境	https://api.wingsdk.com/cpapi/v1/user/push.do
支持Http Method	POST
报文类型	application/json; charset=utf-8
返回信息格式	JSON

请求报文头：

字段	类型	必须	参数说明
appId	String	Y	WA应用ID
sign	String	Y	接口调用签名, 小写MD5(appId + body + secureKey), secureKey （登录验证key）由运营人员在SDK后台生成

body说明：

参数名	类型	是否必须	参数说明
message	Object	Y	消息对象
message.id	String	N	自定义ID，当一次推送任务需要多次请求接口时，可以设置相同的ID，标识为同一任务，便于回溯推送情况(不超过64字符)
message.title	String	Y	消息题目(不超过64字符)
message.body	String	Y	消息内容(不超过200字符)
message.platform	Int	Y	推送平台；0-安卓 1-IOS
message.priority	String	Y	推送优先级；1-低；2-中；3-高；
message.pushType	Int	Y	推送类型；0-自定义uid推送;1-全服推送；
message.uids	List	N	Uid列表（最多支持1000个）,当pushType为”自定义uid推送”时，该参数必须要传值。[123,456,789]

返回格式：

参数名	类型	是否必须	参数说明
code	Int	Y	状态码，请参照附录1
msg	String(32)	Y	结果描述

调用实例：

secretKey: test_secretKey
General
Request URL:https://api.wingsdk.com/cpapi/v1/user/push.do
Request Method:POST
Request Headers
    Content-Type:application/json;charset=utf-8
appId=test-appId
sign=210b46fa81ce1b26a69ed466c53be7b6
Request Body
{"message":{"titile":"test-title","body":"test-body","platform":0,"priority":1,"pushType":0,"uids":[123,456]}}
Response
{
"code":200,
"message":"success"
}
签名说明：
1) 签名待加密字符串
test-appId{"message":{"titile":"test-title","body":"test-body","platform":0,"priority":1,"pushType":0,"uids":[123,456]}}test_secretKey
2) 小写MD5加密
MD5(test-appId{"message":{"titile":"test-title","body":"test-body","platform":0,"priority":1,"pushType":0,"uids":[123,456]}}test_secretKey)
= 210b46fa81ce1b26a69ed466c53be7b6

secretKey: test_secretKey

General

Request URL:https://api.wingsdk.com/cpapi/v1/user/push.do

Request Method:POST

Request Headers

Content-Type:application/json;charset=utf-8

appId=test-appId

sign=210b46fa81ce1b26a69ed466c53be7b6

Request Body

{"message":{"titile":"test-title","body":"test-body","platform":0,"priority":1,"pushType":0,"uids":[123,456]}}

Response

{

"code":200,

"message":"success"

}

签名说明：

1) 签名待加密字符串

test-appId{"message":{"titile":"test-title","body":"test-body","platform":0,"priority":1,"pushType":0,"uids":[123,456]}}test_secretKey

2) 小写MD5加密

MD5(test-appId{"message":{"titile":"test-title","body":"test-body","platform":0,"priority":1,"pushType":0,"uids":[123,456]}}test_secretKey)

= 210b46fa81ce1b26a69ed466c53be7b6

二、奖励通知

2.1 admob激励广告奖励通知接口定义

注意：若尚未实现该接口，可以通过礼包通知接口实现奖励发放

接口说明：

接口相关	说明
接口提供方	CP后台
接口调用方	WA平台
接口实现方式	HTTP/POST
接口描述	玩家观看完激励广告后，WA平台通知CP对玩家进行奖励
生产环境	CP自定义，配置到SDK后台即可。
支持Http Method	POST
请求信息格式	application/x-www-form-urlencoded
返回信息格式	JSON

接口调用说明
连续通知3次，都失败则不再通知。
注1：接口开发完后可以使用调试工具进行测试，前往调试工具
注2：接口的URL ,必须支持HTTPS请求,且使用正规CA机构颁发的证书,不支持自签证书

输入参数说明：

参数名	类型	是否必须	参数说明
appId	String(32)	Y	应用 ID
transactionId	String	Y	广告奖励订单流水号
adName	String	Y	广告名称
rewardItem	String	Y	奖励物品标识：礼包ID，钻石，元宝等
rewardAmount	Int	Y	奖励物品数
userId	Long	Y	玩家的WA平台用户ID
serverId	String	N	玩家所在的游戏服
gameUserId	String	N	游戏角色ID
extInfo	String	N	扩展字段，游戏在客户端观看视频前通过API传给SDK，原样返回给CP后台
osign	String	Y	签名，MD5( appId + transactionId + adName+ rewardItem + rewardAmount + userId + serverId+ gameUserId+ extInfo+ secureKey ) 参数无值则使用””(空字符串)代替参与签名，secureKey 服务端验证key,在SDK后台配置

返回结果说明(JSON格式):
失败返回错误码，请参照附录1的状态码说明表；

参数名	类型	是否必须	参数说明
code	Int	Y	状态码，请参照状态码说明表；
msg	String	Y	结果描述
deliverStatus	int	N	奖励发货状态 0:未知 1:发货成功 2:发货失败 CP在接受到发货通知后，如果能同步确定发货状态，可以返回此状态，如果不能确定发货状态，可以忽略此字段。

三、数据查询接口

3.1 通过第三方OPEN_ID获取WINGSDK平台用户ID

接口说明：

接口相关	说明
接口提供方	WINGSDK平台
接口调用方	CP后端
接口实现方式	HTTP/POST
接口描述	通过第三方平台openId获取WINGSDK平台的userId
生产环境	https://api.wingsdk.com/cpapi/v1/get_user_info.do
支持Http Method	POST
返回信息格式	JSON

输入参数说明：

参数名	类型	是否必须	参数说明
appId	String	Y	WINGSDK平台分配的应用id
platform	String	Y	第三方平台标识： FACEBOOK、APPLE、GOOGLE、GUEST等
openId	String	Y	第三方平台openId
osign	String	Y	验证用的加密串 Md5( appId+ appKey+ //登录验证key，注意保密 platform+ openId )

返回结果说明(JSON格式):
失败返回错误码，请参照状态码说明表；

参数名	类型	是否必须	参数说明
code	Int	Y	状态码，请参照状态码说明表；
msg	String	Y	结果描述
userId	Long	N	SDK平台用户Id

四、充值中心

4.1 查询可购买礼包(商品)列表接口

该接口由移动平台定义，CP负责实现
查询区服信息接口调用说明
1、WingSDK服务端系统通过WingSDK的userId，区服id，角色id来查询玩家可购买的礼包(商品)列表。
2、Url：https://****/gameproductlist.do

注1：接口开发完后可以使用调试工具进行测试，前往调试工具
注2：接口的URL ,必须支持HTTPS请求,且使用正规CA机构颁发的证书,不支持自签证书
注3：此接口返回的礼包(商品)列表需满足充值中心需求：此方案需要保证玩家在游戏内可购买的商品和在充值中心可购买的一致。如：玩家5级时，在游戏内可购买首充礼包和每日礼包，玩家达到5级时登陆充值中心也只展示首充礼包和每日礼包可查看需求及流程

接口说明：

接口相关	说明
接口提供方	CP后端
接口调用方	WINGSDK平台
接口实现方式	HTTP/POST
接口描述	查询玩家可购买的礼包(商品)列表
生产环境	https://****/gameproductlist.do
支持Http Method	POST
请求信息格式	application/x-www-form-urlencoded
返回信息格式	JSON

输入参数说明：

参数名	类型	是否必须	参数说明
appId	String	Y	WINGSDK平台分配的应用id
userId	Long	Y	用户ID，WA游戏平台userId
serverId	String	Y	服务器ID
gameUserId	String	Y	游戏角色ID
osign	String	Y	验证用的加密串Md5(appId+userId+serverId+gameUserId+secureKey ) //secureKey即SDK后台对应的登录密钥, 需运营人员在SDK后台获取

返回结果说明(JSON格式):
失败返回错误码，请参照状态码说明表；

参数名	类型	是否必须	参数说明
code	Int	Y	状态码，请参照状态码说明表；
msg	String	Y	结果描述
gameProductList	object	Y	数组对象
gameProductList为数组对象，包含数据如下，见示例
gameProductType	String	Y	礼包(商品)类型，游戏本地语言或英语，长度限制32字符长度。如：每日礼包，每周礼包
gameProductId	String	Y	礼包(商品)ID
gameProductName	String	Y	礼包(商品)名称(游戏本地语言或英语) ，长度限制32字符长度
gameProductDesc	String	Y	礼包(商品)描述(游戏本地语言或英语)。描述中需要说明限购规则，长度限制250字符长度
waProductId	String	Y	sdk商品ID

示例：

{
    "code": 200,
    "msg": "Successful",
    "gameProductList": [
        {
            "gameProductId": "1",
            "gameProductName": "名称",
            "gameProductDesc": "描述",
            "waProductId": "sdk_1"
        },
        {
            "gameProductId": "",
            "gameProductName": "",
            "gameProductDesc": "",
            "waProductId": ""
        }
    ]
}

{

"code": 200,

"msg": "Successful",

"gameProductList": [

{

"gameProductId": "1",

"gameProductName": "名称",

"gameProductDesc": "描述",

"waProductId": "sdk_1"

{

"gameProductId": "",

"gameProductName": "",

"gameProductDesc": "",

"waProductId": ""

}

]

}

4.2 购买礼包(商品)下单接口

该接口由移动平台定义，CP负责实现
查询区服信息接口调用说明
1、WingSDK服务端系统通过WingSDK的userId，区服id，角色id来查询玩家可购买的礼包(商品)列表。
2、Url：https://****/order.do

接口说明：

接口相关	说明
接口提供方	CP后端
接口调用方	WINGSDK平台
接口实现方式	HTTP/POST
接口描述	查询玩家可购买的礼包(商品)列表
生产环境	https://****/order.do
支持Http Method	POST
请求信息格式	application/x-www-form-urlencoded
返回信息格式	JSON

输入参数说明：

参数名	类型	是否必须	参数说明
appId	String	Y	WINGSDK平台分配的应用id
userId	Long	Y	用户ID，WA游戏平台userId
serverId	String	Y	服务器ID
gameUserId	String	Y	游戏角色ID
gameProductId	String	Y	游戏礼包(商品)ID （需判断gameProductId和waProductId是否对应正确）
waProductId	String	Y	sdk商品ID （需判断gameProductId和waProductId是否对应正确）
osign	String	Y	验证用的加密串Md5(appId+userId+serverId+gameUserId+gameProductId +waProductId+secureKey ) //secureKey即SDK后台对应的登录密钥, 需运营人员在SDK后台获取

返回结果说明(JSON格式):
失败返回错误码，请参照状态码说明表；

参数名	类型	是否必须	参数说明
code	Int	Y	状态码，请参照状态码说明表；
msg	String	Y	结果描述
extInfo	String	N	CP 扩展信息字段，限长512, 发货通知原样返回给CP。CP可以添加任意自定义的字段(JSON格式)，用于检验订单信息或扩展其它功能，不超过长度限制即可。

4.3 查询玩家月卡信息

接口说明：

接口相关	说明
接口提供方	WA平台
接口调用方	CP
接口实现方式	HTTP/POST
接口描述	通过此接口查询玩家月卡信息。
生产环境	https://api.wingsdk.com/cpapi/v1/user/pass_info.do
支持Http Method	POST
请求信息格式	content-type=application/x-www-form-urlencoded
返回信息格式	JSON

输入参数说明：

参数名	类型	是否必须	参数说明
appId	String(100)	Y	WA应用ID
userId	Long	Y	SDK 用户id
osign	Stirng(100)	Y	Md5(appId+userId+secureKey) 如果有参数为空，用空字符串””替代，secureKey （登录验证key）由运营人员在SDK后台生成

返回格式:

参数名	类型	是否必须	参数说明
code	Int	Y	状态码，请参照状态码说明表；
msg	String(32)	Y	结果描述
passStatus	Int	Y	月卡状态：0-未激活；1-已激活
subscribeStatus	Int	N	订阅状态：0-非连续订阅；1-连续订阅
passExpireTimestamp	Long	N	月卡过期时间戳，单位毫秒
passExpireDays	Int	N	剩余多少天过期

4.4 代金券余额通知接口

接口说明：

接口相关	说明
接口提供方	CP平台
接口调用方	WingSDK平台
接口实现方式	HTTP/POST
接口描述	玩家代金券余额更变后通知
生产环境	CP自定义，配置到WingSDK后台即可
支持Http Method	POST
请求信息格式	application/x-www-form-urlencoded
返回信息格式	JSON

输入参数说明：

参数名	类型	是否必须	参数说明
appId	String(32)	Y	应用ID
userId	Long	Y	玩家的WingSDK平台用户ID
voucherAmount	Long	Y	代金券数量
timestamp	Long	Y	当前账号余额更新的时间戳，单位毫秒
osign	Stirng	Y	签名，Md5(appId+userId+voucherAmount+ timestamp+secureKey) 参数无值则使用””(空字符串)替代参与签名，secureKey 服务端验证key，由运营提供

返回结果说明 (JSON格式):

参数名	类型	是否必须	参数说明
code	Int	Y	状态码，请参照状态码说明表；
msg	String(32)	Y	结果描述

服务端接口文档(不常用功能)

Jun

服务端接口文档(不常用功能)

一、消息推送

1.1 消息推送接口

二、奖励通知

2.1 admob激励广告奖励通知接口定义

三、数据查询接口

3.1 通过第三方OPEN_ID获取WINGSDK平台用户ID

四、充值中心

4.1 查询可购买礼包(商品)列表接口

4.2 购买礼包(商品)下单接口

4.3 查询玩家月卡信息

4.4 代金券余额通知接口

Leave a Reply

目录