一、简要说明

本文档的阅读对象为接入并使用SDK开放平台用户的游戏服务器开发者。
通信时SDK均采用UTF8编码。
接口数据请求格式均为form-data，返回格式为json
双发通信时，若有sign字段则一定要验证签名。

openId和openKey的值由商户到QuickSDK海外后台系统设置 -> 开放平台获取

以下文档中接口地址里的http://xxx.com为域名，请联系贵方运营获取，获取之后替换即可

二、接口列表

1. 用户注册接口

1. 接口目的

开发者通过此接口让其平台用户在自己网站上注册账号，并且能正常登录开发者的游戏

2. 接口地址

http://xxx.com/open/userRegister (xxx.com为域名，请联系贵方运营获取,获取之后替换即可)

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
username	string	必传	注册用户名
password	string	必传	注册密码，由原始密码经过32位md5编码后组成
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了用户账号信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
uid	string	必有	SDK用户的账号ID
username	string	必有	SDK用户的账号名
regTime	int	必有	账号注册时间，格式为Unix时间戳

2. 用户登录接口

1. 接口目的

开发者通过此接口让其平台用户在自己网站上登录游戏账号，获取游戏账号信息

2. 接口地址

http://xxx.com/open/userLogin

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
username	string	必传	登录用户名
password	string	必传	登录密码，由原始密码经过32位md5编码后组成
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}

例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了用户账号信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
uid	string	必有	SDK用户的账号ID
username	string	必有	SDK用户的账号名
isGuest	int	必有	是否为游客账号
regTime	int	必有	账号注册时间，格式为Unix时间戳

3. 获取用户订单列表

1. 接口目的

开发者通过此接口让其平台用户在自己网站平台上能直接获取此用户的订单列表

 

2. 接口地址

http://xxx.com/open/orderList

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
userId	string	必传	SDK用户的账号ID
btime	int	选传	查询订单开始时间，格式为 Unix时间戳，时区为北京时间
etime	int	选传	查询订单结束时间，格式为 Unix时间戳，时区为北京时间
payStatus	int	选传	订单状态，固定三个值（0失败，1成功，-1所有）
page	int	选传	查询页码，默认查询最新100条订单，如果有值则取当页20条
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}

例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了订单列表信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
orderNo	string	必有	SDK订单号
productName	string	必有	SDK产品名称
userName	string	必有	SDK用户名
uid	string	必有	SDK账号ID
currencyWord	string	必有	玩家下单币种
amount	float	必有	玩家下单对应币种金额
usdAmount	float	必有	玩家下单对应美元金额
dealAmount	float	必有	玩家实际支付对应币种金额
dealUsdAmount	float	必有	玩家实际支付对应美元金额
actRate	float	必有	支付折扣，默认为1无折扣，取值范围0-1(不包含0)
dealRate	float	必有	下单币种对应美元的汇率
createTime	int	必有	订单创建时间，格式为Unix时间戳
productOrderNo	string	必有	游戏订单号
channelOrderNo	string	必有	支付渠道订单号
payStatus	int	必有	支付状态，0表示未支付成功，1表示支付成功
asyncStatus	int	必有	订单通知游戏发货状态,0表示未支付成功，1表示支付成功
payTime	int	必有	订单支付时间，只有支付成功时才有值
payTypeName	string	必有	支付方式名称
payTypeId	int	必有	支付方式ID
orderGoodsId	string	必有	订单商品ID

4. 获取用户订单详情

1. 接口目的

开发者通过此接口让其平台用户在自己网站平台上能直接获取此用户某条订单详情

2. 接口地址

http://xxx.com/open/orderInfo

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
userId	string	必传	SDK用户的账号ID
orderNo	string	必传	SDK    订单号
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了订单详细信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
orderNo	string	必有	SDK订单号
productName	string	必有	SDK产品名称
userName	string	必有	SDK用户名
uid	string	必有	SDK账号ID
currencyWord	string	必有	玩家下单币种
amount	float	必有	玩家下单对应币种金额
usdAmount	float	必有	玩家下单对应美元金额
dealAmount	float	必有	玩家实际支付对应币种金额
dealUsdAmount	float	必有	玩家实际支付对应美元金额
actRate	float	必有	支付折扣，默认为1无折扣，取值范围0-1(不包含0)
dealRate	float	必有	下单币种对应美元的汇率
createTime	int	必有	订单创建时间，格式为Unix时间戳
productOrderNo	string	必有	游戏订单号
channelOrderNo	string	必有	支付渠道订单号
payStatus	int	必有	支付状态，0表示未支付成功，1表示支付成功
payTime	int	必有	订单支付时间，只有支付成功时才有值
payTypeName	string	必有	支付方式名称
payTypeId	int	必有	支付方式ID
serverName	string	必有	玩家角色所在游戏区服
roleName	string	必有	玩家角色名
roleLelvel	int	必有	玩家角色等级
asyncStatus	int	必有	订单通知游戏发货状态，0表示未支付成功，1表示支付成功
asyncTime	int	必有	订单通知游戏成功时间，格式为Unix时间戳。只有同步游戏成功时才有值
extrasParams	string	必有	游戏下单自定义扩展参数
orderGoodsId	string	必有	订单商品ID
orderSubject	string	必有	订单商品描述
channelCode	string	必有	游戏分包CPS渠道CODE
isSandbox	int	必有	是否沙盒订单，1是，0不是

5. 获取充值下单页面链接参数

1. 接口目的

开发者通过此接口让其平台用户在自己网站平台上直接充值

2. 接口地址

http://xxx.com/open/getPayUrl    (xxx.com为域名，请联系贵方运营获取,获取之后替换即可)

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
userId	string	必传	SDK用户的账号ID
goodsId	string	必传	游戏商品id
cpOrderNo	string	选传	游戏订单号
orderSubject	string	必传	订单标题
roleName	string	必传	用户角色名
serverName	string	必传	游戏服务器名
goodsName	string	必传	商品名称
roleLevel	int	必传	用户角色等级
extrasParams	string	必传	订单保留参数，原样返回给cp
callbackUrl	string	选传	订单回调地址,就是通知cp服务器发货的通知地址
payType	string	选传	支付方式ID，ID获取请参照SDK后台“平台管理”>“支付对照表”。支持多种支付方式，多个支付方式以“|”隔开，比如：12|13|23 注意：支付方式ID需满足后台勾选已经支持的第三方支付方式，否则无法显示指定支付方式渠道
countryCode	string	选传	国家代码，如CHN。获取请参照SDK后台“平台管理”>“地区管理” 注意：国家代码需满足后台勾选已经支持的第三方支付方式，否则无法显示指定国家的支付
clientLang	string	必传	支付中心语言包，填写地区语言代码，如en-US。默认为中文繁体
payVersion	int	选传	第三方支付版本，默认不填写为SDK常规版本。取固定值为： 2. 表示平台单独处理版本，此版本平台需传金额和币种进行支付并且SDK不参与商品金额的转换由平台自身处理，平台根据自身情况酌情考虑使用。
amount	float	选传	订单金额。如果payVersion的值为2，则必传amount字段
currency	string	选传	选传 订单支付的币种代码。如果payVersion的值为2，则必传currency字段 注意：支付币种代码必须为SDK后台货币管理里面所支持的货币代码
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}

例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了下单页面详细信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
payUrl	string	必有	SDK充值中心页面的URL地址

注：此接口会返回下单页面的url地址，开发者需在自己平台上接收到此地址时调起此页面才能进行支付。

6. 发送邮箱验证码接口

1. 接口目的

开发者通过此接口让其平台用户在自己网站平台上进行找回密码时发送邮箱验证码

2. 接口地址

http://xxx.com/open/sendCodeByEmail

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
email	string	必传	用户邮箱
sendType	int	必传	验证类型，取固定值。具体含义为： 1.邮箱注册 2.绑定邮箱 3.解绑邮箱 4. 找回密码
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了邮件验证码过期信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
expires_in	string	必有	验证码过期时间，格式为Unix时间戳
message	string	必有	验证码发送成功消息

7. 用户密码找回接口

1. 接口目的

开发者通过此接口让其平台用户在自己网站平台上进行找回密码并重置密码操作

注：调用此接口前，开发者需要调用前置接口“发送邮箱验证码接口”，来验证用户的邮箱真实性并获取邮箱验证码

2. 接口地址

http://xxx.com/open/setNewPass

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
email	string	必传	用户邮箱
code	string	必传	邮箱验证码
newPassword	string	必传	新密码，由原始密码经过32位md5编码后组成
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了用户信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
uid	string	必有	SDK用户的账号ID
username	string	必有	SDK用户的账号名
isGuest	int	必有	是否为游客账号
regTime	int	必有	账号注册时间，格式为Unix时间戳

8. 用户修改密码

1. 接口目的

开发者通过此接口让其平台用户在自己网站平台上进行修改密码操作

2. 接口地址

http://xxx.com/open/userChangePass

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
userId	string	必传	SDK用户的账号ID
oldPassword	string	必传	原密码，由原始密码经过32位md5编码后组成
newPassword	string	必传	新密码，由原始密码经过32位md5编码后组成
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了用户信息

9. 获取厂商所有游戏列表

1. 接口目的

开发者通过此接口让其平台获取所有的游戏列表

2. 接口地址

http://xxx.com/open/getOpenProduct

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}

例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了产品列表信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
id	int	必有	SDK产品ID
name	string	必有	SDK产品名称
productCode	string	必有	SDK产品CODE
platform	int	必有	产品平台，固定值： 1. Android 2. iOS 3. H5

10. 获取游戏商品配置列表

1. 接口目的

开发者通过此接口让其平台获取在SDK配置的游戏所有商品列表

2. 接口地址

http://xxx.com/open/goodsList

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了产品商品列表信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
goodsId	string	必有	商品ID
price	float	必有	商品金额（SDK后台配置的商品金额统一为美元）

11. 第三方社交账号登录

1. 接口目的

开发者通过此接口可接入第三方社交账号登录

2. 接口地址

http://xxx.com/open/snsLogin

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
openType	int	必传	社交账号类型，填写固定值： 6 Facebook登录 8 Google+登录 9 Naver登录 10 Twitter登录 11 Line登录 14 VK 16 Apple登录 17 Google Play登录
userOpenId	string	必传	社交账号对应玩家的唯一标识 注意：如果是Google+登录，并且贵方平台使用的jwt格式验证，那么userOpenId传固定值“CREDENTIAL”
access_token	string	必传	社交账号获取玩家的凭证，如果登录方式没有的则传随机字符串即可 注意：如果是Google+登录，并且贵方平台使用的jwt格式验证，那么access_token传Google返回的 credential字段的值
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了用户账号信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
uid	int	必有	SDK用户的账号ID
username	string	必有	SDK用户的账号名
authToken	string	必有	SDK用户自动登录token串
isGuest	int	必有	是否为游客

12. SDK账号电子钱包充值/扣费(产品需开通钱包功能)

1. 接口目的

开发者通过此接口可向SDK用户充值或者扣除电子钱包余额

2. 接口地址

http://xxx.com/open/payToUser

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
userId	string	必传	SDK用户的uid
amount	float	必传	正数为充值金额，负数为扣除金额，最多两个小数
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了用户钱包信息

13. 获取SDK账号电子钱包余额(产品需开通钱包功能)

1. 接口目的

开发者通过此接口可获取SDK用户电子钱包余额

2. 接口地址

http://xxx.com/open/walletInfo

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
userId	string	必传	SDK用户的uid
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了用户钱包余额信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
amount	float	必有	玩家电子钱包余额

14. 游客账号模式

1. 接口目的

开发者通过此接口可在网页平台生成游客账号进行登录

注意：开放平台使用的游客账号模式由于设备ID是平台自身生成，所以生成的游客账号可能没法在原始SDK中进行登录使用，需平台绑定账号后才能使用

2. 接口地址

http://xxx.com/open/visitorReg

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
deviceId	string	必传	玩家在网页平台的设备唯一标识
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了游客账号信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
uid	string	必有	SDK用户的账号ID
username	string	必有	SDK用户的账号名
isGuest	int	必有	是否为游客账号
regTime	int	必有	账号注册时间，格式为Unix时间戳

15. 账号绑定邮箱

1. 接口目的

开发者通过此接口可在网页平台对SDK账号进行绑定邮箱操作

2. 接口地址

http://xxx.com/open/bindEmail

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
userId	string	必传	SDK用户的uid
email	string	必传	要绑定的邮箱账号
code	string	必传	邮箱验证码。验证码获取可参照第二章6点的发送验证码接口
password	string	必传	绑定邮箱时需设置的初始密码，由原始密码经过32位md5编码后组成
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}

例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false。平台可判断status为true时表示绑定成功
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了邮箱信息

16. 绑定第三方社交账号

1. 接口目的

开发者通过此接口可让SDK账号绑定第三方社交账号

2. 接口地址

http://xxx.com/open/bindSns

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
userId	string	必传	SDK用户的账号ID
openType	int	必传	社交账号类型，填写固定值： 6 Facebook登录 8 Google+登录 9 Naver登录 10 Twitter登录 11 Line登录 14 VK 16 Apple 17 Google Play 18 94Hi会员
userOpenId	string	必传	社交账号对应玩家的唯一标识
access_token	string	必传	社交账号获取玩家的凭证，如果登录方式没有的则传随机字符串即可
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了用户账号信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
uid	int	必有	SDK用户的账号ID
username	string	必有	SDK用户的账号名
authToken	string	必有	SDK用户自动登录token串
isGuest	int	必有	是否为游客账号

17. 向SDK同步订单

1. 接口目的

开发者通过此接口让其平台的订单同步到SDK系统

注意：此接口目的是把平台的订单号同步到SDK，所以建议在平台向玩家发货之后同步即可，同步时把支付和发货状态加上。否则订单无法修改

2. 接口地址

http://xxx.com/open/createOrder

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
userId	string	必传	SDK用户的账号ID
goodsId	string	必传	游戏商品id
cpOrderNo	string	选传	游戏订单号
orderSubject	string	必传	订单标题
roleName	string	必传	用户角色名
serverName	string	必传	游戏服务器名
amount	float	必传	订单金额
goodsName	string	选传	商品名称
roleLevel	int	选传	用户角色等级
extrasParams	string	选传	订单保留参数
callbackUrl	string	选传	订单回调地址
payType	int	必传	支付方式ID，ID获取请参照SDK后台“平台管理”>“支付对照表”
deviceId	string	选传	订单的设备信息
channelCode	string	选传	渠道CODE
payStatus	int	选传	订单支付状态，默认为0，取固定值： 1．支付成功 0．支付失败
asyncStatus	int	选传	订单发货状态，默认为0，取固定值： 1. 发货成功 0. 发货失败
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了订单信息

18. 创建内购订单

1. 接口目的

开发者通过此接口可创建App Store和Google内购订单

2. 接口地址

http://xxx.com/open/purchaseOrder

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
userId	string	必传	SDK用户的账号ID
goodsId	string	必传	游戏商品id
cpOrderNo	string	选传	游戏订单号
orderSubject	string	选传	订单标题
roleName	string	选传	用户角色名
serverName	string	选传	游戏服务器名
goodsName	string	选传	商品名称
roleLevel	int	选传	用户角色等级
extrasParams	string	选传	订单保留参数
callbackUrl	string	选传	订单回调地址
payType	int	必传	支付方式ID，取固定值 8. iOS内购 30. Google内购
deviceId	string	选传	订单的设备信息
channelCode	string	选传	渠道CODE
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}

例2 {"status":true,"message":"","data":[]}

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
orderNo	string	必有	SDK的订单号

19. 验证Google订单票据

1. 接口目的

开发者通过此接口验证Google内购订单玩家支付后的票据

2. 接口地址

http://xxx.com/open/postGooglePlayVerify

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
signature	string	必传	验证类型，取固定值： SIGNATURE-V3：普通内购订单验证票据 SUBSCRIPTIONS-V3：订阅型商品订单验证票据
purchaseData	string	必传	Google支付成功后回调给客户端的订单票据
orderNum	string	选传	SDK订单号，当 signature的值为 SIGNATURE-V3时必传
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}

例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了订单信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
message	string	必有	SDK验证票据成功时返回的信息

20. 验证iOS订单票据

1. 接口目的

开发者通过此接口验证iOS内购订单玩家支付后的票据

2. 接口地址

http://xxx.com/open/postAppstoreTicket

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
orderNo	string	必传	SDK订单号
transactionId	string	必传	iOS支付成功的订单交易ID
ticket	string	选传	iOS支付成功返回给客户端的票据，需要先进行base64编码后再传给SDK验证
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了订单K验证票据成功信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
message	string	必有	SDK验证票据成功时返回的信息

21. 获取游戏单日报表数据

1. 接口目的

开发者通过此接口获取游戏单日报表数据

2. 接口地址

http://xxx.com/open/daysReport

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
bdate	string	可选	指定获取数据开始日期，默认当前日期前一天 格式为:YYYY-MM-DD
edate	string	可选	指定获取数据结束日期，默认当前日期 格式为:YYYY-MM-DD
pids	string	可选	指定游戏ID，多个游戏以“,”分隔，默认当前游戏
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}

例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了列表信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
date	string	必有	报表数据日期，格式为：YYYY-MM-DD
productId	int	必有	产品名id
productName	string	必有	产品名
channelCode	string	必传	渠道CODE
newUser	int	必有	当日注册用户
newDevice	int	必有	当日新增设备数
activeUser	int	必有	当日游戏激活用户
userLogin	int	必有	当日活跃用户
allPay	float	必有	当日玩家充值总额
allPayUser	int	必有	当日付费玩家数
newPayUser	int	必有	当日新用户付费数
newUserPayCount	int	必有	当日新用户充值笔数
newUserPay	float	必有	当日的新用户充值额
payCount	int	必有	当日总充值笔数
firstPayUser	int	必有	当日新增付费用户数
totalPayUser	int	必有	累计付费数，指此产品到当日所有产生付费行为的用户数

22. 获取产品退款列表

1. 接口目的

开发者通过此接口能直接获取产品订单退款列表

2. 接口地址

http://xxx.com/open/orderRefund

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
btime	int	选传	查询退款订单开始时间，格式为 Unix时间戳，时区为北京时间。不传默认为当前时间前一个月
etime	int	选传	查询退款订单结束时间，格式为 Unix时间戳，时区为北京时间。不传默认为当前时间
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了订单列表信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
orderNo	string	必有	SDK订单号
productId	int	必有	SDK产品ID
productName	string	必有	SDK产品名称
uid	string	必有	SDK账号ID
usdAmount	float	必有	订单对应美元金额
productOrderNo	string	必有	游戏订单号
channelOrderNo	string	必有	支付渠道订单号
payType	int	必有	支付方式ID 8：iOS内购 30：Google内购
goodsId	string	必有	订单商品ID
serverName	string	必有	订单对应玩家游戏区服名
roleName	string	必有	订单对应玩家游戏角色名
extrasParams	string	必有	订单扩展参数
voidedTime	int	必有	订单退款时间，格式为unix时间戳

23. 获取用户信息

1. 接口目的

开发者通过此接口获取SDK账号信息

2. 接口地址

http://xxx.com/open/userInfo

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
userId	string	必传	SDK用户的账号ID
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了用户账号信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
uid	string	必有	SDK用户的账号ID
username	string	必有	SDK用户的账号名
isGuest	int	必有	是否为游客账号
regTime	int	必有	账号注册时间，格式为Unix时间戳

24. 获取产品订单列表

1. 接口目的

开发者通过此接口让其平台用户在自己网站平台上能直接获取游戏的订单列表

2. 接口地址

http://xxx.com/open/queryOrderList

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
btime	int	选传	查询订单开始时间，格式为 Unix时间戳，时区为北京时间
etime	int	选传	查询订单结束时间，格式为 Unix时间戳，时区为北京时间
payStatus	int	选传	订单状态，固定三个值（0失败，1成功，-1所有）
page	int	选传	查询页码，默认查询最新500条订单，如果有值则取当页订单列表
pageRows	int	选传	每页显示订单量，默认为20，最大不超过100
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了订单列表信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
orderNo	string	必有	SDK订单号
productName	string	必有	SDK产品名称
userName	string	必有	SDK用户名
uid	string	必有	SDK账号ID
currencyWord	string	必有	玩家下单币种
amount	float	必有	玩家下单对应币种金额
usdAmount	float	必有	玩家下单对应美元金额
dealAmount	float	必有	玩家实际支付对应币种金额
dealUsdAmount	float	必有	玩家实际支付对应美元金额
actRate	float		支付折扣，默认为1无折扣，取值范围0-1(不包含0)
dealRate	float	必有	下单币种对应美元的汇率
createTime	int	必有	订单创建时间，格式为Unix时间戳
productOrderNo	string	必有	游戏订单号
channelOrderNo	string	必有	支付渠道订单号
payStatus	int	必有	支付状态，0表示未支付成功，1表示支付成功
asyncStatus	int	必有	订单通知游戏发货状态,0表示未支付成功，1表示支付成功
payTime	int	必有	订单支付时间，只有支付成功时才有值
payTypeName	string	必有	支付方式名称
payTypeId	int	必有	支付方式ID
orderGoodsId	string	必有	订单商品ID
serverName	string	必有	游戏区服信息
roleName	string	必有	游戏角色信息
asyncTime	int	必有	订单通知游戏发货时间，只有发货状态成功才有值
channelCode	string	必有	SDK渠道CODE
extrasParams	string	必有	订单扩展参数

25. 创建订单支付链接

1. 接口目的

开发者通过此接口让其平台用户在自己网站平台上直接充值

注意：此接口的的金额依赖于开发者上传，所以不需要SDK的商品ID配置信息。如果支付币种为非美元币种，建议在SDK后台货币管理配置币种汇率，以便SDK统计对应美元金额

2. 接口地址

http://xxx.com/open/startPay

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
userId	string	必传	SDK用户的账号ID
goodsId	string	必传	游戏商品id
cpOrderNo	string	选传	游戏订单号
orderSubject	string	必传	订单标题
roleName	string	必传	用户角色名
serverName	string	必传	游戏服务器名
goodsName	string	选传	商品名称
roleLevel	int	选传	用户角色等级
extrasParams	string	选传	订单保留参数，原样返回给cp
callbackUrl	string	选传	订单回调地址,就是通知cp服务器发货的通知地址
payType	string	必传	支付方式ID，ID获取请参照SDK后台“平台管理”>“支付对照表” 注意：支付方式ID需满足后台勾选已经支持的第三方支付方式，否则无法创建支付链接
clientLang	string	必传	支付中心语言包，填写地区语言代码，如en-US。默认为中文繁体
amount	float	必传	订单支付金额
currency	string	必传	订单支付的币种代码。 注意：支付币种代码必须为SDK后台货币管理里面所支持的货币代码
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了下单页面详细信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
orderNo	string	必有	SDK订单号
payParams	string	必有	订单支付链接，开发者获取此链接并跳转拉起第三方支付渠道收银台

26. 设备上报接口

1. 接口目的

开发者通过此接口让其平台用户在自己网站平台上接入设备信息上报
注意：一个产品与一个设备ID形成唯一约束，已存在的不会重复上报

2. 接口地址

http://xxx.com/open/deviceRegist

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
channelCode	string	选传	渠道CODE
deviceId	string	必传	设备ID
platform	Int	必传	平台：1 安卓 2 iOS
deviceName	string	必传	设备名称，如 Pixel 3
osName	Int	选传	操作系统，android或ios
osVersion	string	必传	操作系统数字版本，如24表示安卓7.0
osLanguage	string	选传	系统语言，如zh、en
countryCode	string	选传	所在地区，如cn
ismobiledevice	Int	选传	是否为手机设备，1是 0否
imei	string	选传	IMEI
imsi	string	选传	IMSI
wifimac	string	选传	网络MAC地址
bluetoothMac	string	选传	蓝牙MAC地址
screenHeight	Int	选传	屏幕高度
screenWidth	Int	选传	屏幕宽度
dpi	string	选传	DPI
pushToken	string	选传	需要使用推送传入客户端推送Token
isJailbroken	Int	选传	是否越狱/ROOT，1是 0否
javasupport	Int	选传	是否支持JavaScript，1是 0否
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	空

27. 解绑第三方社交账号

1. 接口目的

开发者通过此接口可解绑SDK账号的第三方社交账号

2. 接口地址

http://xxx.com/open/unBindSns

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
userId	string	必传	SDK用户的账号ID
openType	int	必传	社交账号类型，填写固定值： 6 Facebook登录 8 Google+登录 9 Naver登录 10 Twitter登录 11 Line登录 14 VK 16 Apple 17 Google Play 18 94Hi会员
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了用户账号信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
uid	int	必有	SDK用户uid
username	string	必有	SDK用户名
authToken	string	必有	SDK用户自动登录token串
isGuest	int	必有	是否为游客

28. SDK自动授权登录

1. 接口目的

开发者通过此接口实现玩家自动登录，免除玩家手动输入账号密码操作

2. 接口地址

http://xxx.com/open/autoLogin

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
authToken	string	必传	SDK自动登录授权token,在登录、注册接口有返回
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了用户账号信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
uid	string	必有	SDK用户的账号ID
username	string	必有	SDK用户的账号名
isGuest	int	必有	是否为游客账号
regTime	int	必有	账号注册时间，格式为Unix时间戳
token	string	必有	SDK服务端验证用户信息接口使用token
authToken	string	必有	SDK自动登录接口授权token

29. 获取游戏账号留存报表数据

1. 接口目的

开发者通过此接口获取游戏账号留存报表数据

2. 接口地址

http://xxx.com/open/userLiveReport

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
bdate	string	可选	指定获取数据开始日期，默认当前日期前一天 格式为:YYYY-MM-DD
edate	string	可选	指定获取数据结束日期，默认当前日期 格式为:YYYY-MM-DD
pids	string	可选	指定游戏ID，多个游戏以“,”分隔，默认当前游戏
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：

例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了列表信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
date	string	必有	报表数据日期，格式为：YYYY-MM-DD
productId	int	必有	产品ID
productName	string	必有	产品名
activeUser	int	必有	当日游戏激活用户
userLogin	int	必有	当日活跃用户
live_{n}	int	必有	对应第n天的留存用户

30. 获取玩家游戏记录

1. 接口目的

开发者通过此接口获取玩家的游戏激活记录以及每个游戏下的角色记录

2. 接口地址

http://xxx.com/open/userGames

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
userId	string	必传	SDK系统玩家的UID
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：
例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了列表信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
productCode	string	必有	SDK产品CODE
productName	string	必有	SDK产品名称
uid	string	必有	SDK系统玩家的UID
roles	object	可为空	玩家角色记录，每个对象包含如下字段： roleId:角色ID roleName:角色名 serverName:区服名 serverId:区服ID

31. 邮箱换绑原邮箱验证码校验接口

1. 接口目的

开发者通过此接口让其平台用户在自己网站上通过邮箱校验原邮箱真实性
注意：调用此接口需要先调用发送邮箱验证码接口以获取邮箱验证码 

2. 接口地址

http://xxx.com/open/ckMailCode

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
uid	int	必传	SDK用户ID
mail	string	必传	原邮箱账号
code	string	必传	邮箱验证码
sendType	int	必传	取固定值3
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：
例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	status为false时，message有值，为错误提示语
data	array	可为空	无

32. 邮箱换绑新邮箱绑定接口

1. 接口目的

开发者通过此接口让其平台用户在自己网站上通过邮箱绑定账号 
注意：调用此接口需要先调用发送邮箱验证码接口以获取邮箱验证码 

2. 接口地址

http://xxx.com/open/reBindMail

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
uid	int	必传	SDK用户ID
mail	string	必传	原邮箱账号
newMail	string	必传	新邮箱账号
newCode	string	必传	新邮箱验证码
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：
例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了用户账号信息

注：以下参数只有当status为true且data不为空才有

参数	必要性	说明
uid	必有	SDK用户的账号ID
username	必有	SDK用户的账号名
isGuest	必有	是否为游客账号
regTime	必有	账号注册时间，格式为Unix时间戳
mobile	必有	手机号，包含地区代码
authToken	必有	SDK自动登录接口授权token

33. 获取玩家游戏角色记录

1. 接口目的

开发者通过此接口获取玩家的游戏角色记录

2. 接口地址

http://xxx.com/open/rolesList

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
frType	int	必传	查询角色方式，取固定枚举值： 1.通过SDK的UID查询 2.通过玩家角色ID查询
uid	int	必传	SDK用户ID
roleId	string	选传	游戏角色ID，如果frType传2时，此参数必传
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：
例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了列表信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
serverName	string	必有	游戏角色对应区服名
uid	string	必有	SDK用户的账号名
roleId	string	必有	角色ID
roleName	string	必有	角色名
角色等级	string	必有	角色等级

34. 获取游戏账号LTV报表数据

1. 接口目的

开发者通过此接口获取游戏账号LTV报表数据

2. 接口地址

http://xxx.com/open/ltvReport

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
bdate	string	可选	指定获取数据开始日期，默认当前日期前一天 格式为:YYYY-MM-DD
edate	string	可选	指定获取数据结束日期，默认当前日期。 格式为:YYYY-MM-DD
pids	string	可选	指定游戏ID，多个游戏以“,”分隔，默认当前游戏
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

接口会返回JSON格式字符串，如：
例1 {"status":false,"message":"tokenUidError",”data”:[]}
例2 {"status":true,"message":"","data":[]}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	status为false时，message有值，为错误提示语
data	array	可为空	如果status为true时，data数组包含了列表信息

注：以下参数只有当status为true且data不为空才有

参数	类型	必要性	说明
date	string	必有	报表数据日期，格式为：YYYY-MM-DD
productId	int	必有	产品ID
productName	string	必有	产品名
activeUser	int	必有	当日游戏激活用户
actUserPay	float	必有	激活用户付费
ltv{n}	int	必有	对应第n天的LTV

三、签名算法描述

1. 将需要传递的参数按首字母升序排序。
2. 将所有键值对按 key1=val1&key2=val2&key3=val3& 格式进行拼接。
3. 在第2步拼接的字符后拼接SDK分配的openKey则此时格式为：
key1=val1&key2=val2&key3=val3&openKey
4. 将第3步处理的字符串进行md5编码，得到32位小写md5值
代码片段参见第四章

四、代码片段

/**
 * 本地计算MD5签名PHP示例代码
    * @params $callbackey SDK后台分配的通信密钥
   * @return 本地计算的md5签名值
     */
public function getMd5Sign($params,$openKey){
 ksort($params);
 $signKey = '';
 foreach($params as $key => $val){
 $signKey .= $key.'='.$val.'&';
 }
 $signKey .= $openKey;
 return md5($signKey);
}