一、简要说明

本文档的阅读对象为接入并使用SDK开放平台用户的游戏服务器开发者
通信时SDK均采用UTF8编码
双方通信时，若有sign字段则一定要验证签名
接口数据请求格式均为form-data，返回格式为json
openId和openKey的值由商户到Quick官方SDK后台系统设置 -> 开放平台获取

二、接口列表

1. 用户注册接口

1. 接口目的

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

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/userRegister

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在QuickSDK官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
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数组包含了用户账号信息

2. 用户登录接口

用户登录接口分为两种情况：

    1.游戏或应用自身包含登录界面，则直接调用1.1登录授权接口 webOpen/userLogin

    2.游戏或应用自身不包含登录界面，则调用2.1 webOpen/oauth 接口生成登录地址，并跳转至登录页面，待用户完成登录后通过successUrl跳转回应用界面。

1.1. 接口目的

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

1.2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/userLogin

1.3. 请求方式

POST

1.4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
username	string	必传	登录用户名
password	string	必传	登录密码，由原始密码经过32位md5编码后组成
sign	string	必传	签名串，算法详见第三章签名算法描述

1.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数组包含了用户账号信息

2.1. 接口目的

开发者通过此接口构造登录页面地址。

2.2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/oauth

2.3. 请求方式

POST

2.4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
successUrl	string	必传	完成登录后的回调地址
cancalUrl	string	可选	取消时跳转的URL
sign	string	必传	签名串，算法详见第三章签名算法描述

2.5. 返回字段

此接口将返回一个URL，浏览器应用可直接跳转至该URL，PC或其他应用可通过webview打开该URL。

此URL将显示登录界面，玩家在该界面登录完成后，将跳转至接口传入的successUrl，并附带用户信息。

浏览器应用可以在successUrl中，获取GET参数中的用户信息，包括uid、username、authToken，通过 webOpen/queryUser 接口验证查询玩家信息。

PC或其他应用可监听webview URLChange事件，当URL改变为传入的successUrl时，截获URL并获取GET参数。

successUrl附带的参数如下

参数	类型	必要性	说明
uid	bool	必有	玩家uid，获取到该uid后，应使用authToken查询用户，验证该uid是否与authToken对应的uid一致。
username	string	必有	玩家用户名
timeLeft	int	必有	玩家可游戏时间，单位秒，客户端可设置定时器，在该秒数后注销登录
authToken	array	可为空	为防止来自URL的信息被篡改，游戏获取到uid、authToken后应调用 webOpen/queryUser 接口验证authToken对应的uid是否匹配

3. 获取用户订单列表

1. 接口目的

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

 

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/orderList

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
userId	string	必传	游戏用户的uid
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	必有	产品名称
userName	string	必有	用户名
uid	string	必有	用户UID
amount	float	必有	订单下单金额
dealAmount	float	必有	订单成功支付通知游戏金额
createTime	int	必有	订单创建时间，格式为Unix时间戳，时区为北京时间
productOrderNo	string	必有	游戏订单号
channelOrderNo	string	必有	支付渠道订单号
payTime	int	必有	订单支付时间，格式为 Unix时间戳，时区为北京时间
channelCode	string	必有	渠道CODE
payTypeName	string	必有	支付渠道名称

4. 获取用户订单详情

1. 接口目的

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

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/orderInfo

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
userId	string	必传	游戏用户的uid
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数组包含了订单详细信息

5. 获取产品订单列表

1.接口目的

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

2.接口地址

http://quickgame.sdk.quicksdk.net/webOpen/queryOrderList

3.请求方式

POST

4.参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
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	必有	产品名称
userName	string	必有	用户名
uid	string	必有	用户UID
amount	float	必有	订单下单金额
dealAmount	float	必有	订单成功支付通知游戏金额
createTime	int	必有	订单创建时间，格式为Unix时间戳，时区为北京时间
productOrderNo	string	必有	游戏订单号
channelOrderNo	string	必有	支付渠道订单号
payStatus	int	必有	支付状态，返回固定值： 0 支付失败或者未支付 1 支付成功
payTime	int	必有	订单支付时间，只有支付状态为1时才会有支付时间，默认为0。格式为 Unix时间戳，时区为北京时间
asyncStatus	int	必有	同步游戏状态，返回固定值： 0 同步失败 1 同步成功
asyncTime	int	必有	订单同步游戏时间，只有同步状态为1时才会有同步时间，默认为0。格式为 Unix时间戳，时区为北京时间
channelCode	string	必有	渠道CODE
payTypeName	string	必有	支付渠道名称

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

1. 接口目的

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

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/getPayUrl

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
userId	string	必传	游戏用户的uid
amount	float	必传	订单总额,最多保留2位小数精确到分
cpOrderNo	string	选传	游戏订单号
orderSubject	string	必传	订单标题
goodsName	string	必传	商品名称
roleName	string	必传	用户角色名
serverName	string	必传	游戏服务器名
roleLevel	int	选传	用户角色等级
extrasParams	string	选传	订单保留参数，原样返回给cp
callbackUrl	string	选传	订单回调地址，就是通知cp服务器发货的通知地址
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数组包含了下单页面详细信息

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

7. 发送短信验证码接口（需开通短信功能）

1. 接口目的

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

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/sendCodeByPhone

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
phone	string	必传	用户手机号码
sendType	int	必传	验证类型，取固定值 1为手机验证登录 2为绑定手机 3为解绑手机 4为找回密码
uid	string	选传	用户id；当sendType为2、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	可为空	如果status为true时，data数组包含了短信验证码过期信息

8. 手机号码登录（需开通短信功能）

1.接口目的

开发者通过此接口让其平台用户在自己网站平台上进行手机号码登录

注：调用此接口前，开发者需要调用前置接口“发送短信验证码接口”，来获取短信验证码

2.接口地址

http://quickgame.sdk.quicksdk.net/webOpen/loginByPhone

3.请求方式

POST

4.参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
phone	string	必传	用户手机号码
code	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数组包含了用户账号信息

      

9. 用户密码找回接口

1. 接口目的

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

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

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/setNewPass

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
phone	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数组包含了用户信息

10. 用户修改密码

1. 接口目的

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

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/userChangePass

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
userId	string	必传	用户uid
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数组包含了用户密码信息

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

1. 接口目的

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

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/getOpenProduct

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
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数组包含了产品列表信息

12. 用户实名认证

1. 接口目的

开发者通过此接口让其平台用户在平台上实现实名认证功能

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/userVerify

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
uid	string	必传	用户uid
realname	string	必传	用户真实名字
idcard	string	必传	用户身份证号码
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

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

例1 {"status":false,"message":"此用户已实名认证",”data”:[]}
例2 {"status":true,"message":"","data":[]}

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

13. 获取用户实名认证状态

1. 接口目的

开发者通过此接口获取用户的实名认证状态

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/checkUserVerify

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
uid	string	必传	用户uid
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

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

例1 {"status":true,"data":{"isVerified":1},"message":""}

参数	类型	必要性	说明
status	bool	必有	接口验证状态，若通过验证为true，否则为false
message	string	必有	Status为false时，message有值，为错误提示语
data	array	可为空	status为true时，data里包含实名认证状态 isVerified：是否实名认证，1为已认证，0为未认证

14. 用户绑定手机号码

1. 接口目的

开发者通过此接口让其平台用户在自己网站平台上绑定手机号码

注：调用此接口前，开发者需要调用前置接口“发送短信验证码接口”，来获取短信验证码

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/bindPhone

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
phone	string	必传	用户手机号码
code	string	必传	短信验证码
uid	string	必传	用户id
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

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

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

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

15. 用户解绑手机号码

1. 接口目的

开发者通过此接口让其平台用户在自己网站平台上解绑手机号码

注：调用此接口前，开发者需要调用前置接口“发送短信验证码接口”，来获取短信验证码

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/unBindPhone 

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
code	string	必传	短信验证码
uid	string	必传	用户id
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

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

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

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

16. 用户名+手机号注册接口

1. 接口目的

开发者通过此接口让其平台用户在自己网站上注册账号，并且能正常登录开发者的游戏。
注：调用此接口前，开发者需要调用前置接口“发送短信验证码接口”，来获取短信验证码

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/upassportReg

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
username	string	必传	注册用户名
password	string	必传	注册密码，由原始密码经过32位md5编码后组成
phone	string	必传	手机号码
code	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数组包含了用户账号信息

17. 注册人数TopN产品

1. 接口目的

开发者通过此接口获取注册人数由高到低排序的产品。数据日期为指定日志过去一月内上线的游戏

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/registerTop

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
date	string	可选	指定获取数据日期，默当前日期认前一天
limit	Int	可选	数据排序TopN，默认20
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数组包含了用户账号信息

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

参数	类型	必要性	说明
date	string	必有	指定获取数据日期，默当前日期认前一天
productOnline	string	必有	指定获取数据日期前一月游戏上线日期
list	Array	必有	产品对象数组，每个数组元素对象包含产品CODE和产品名
productCode	string	必有	产品CODE，在Quick官方SDK后台获取
productName	string	必有	产品名

18. 活跃和付费率TopN产品

1. 接口目的

开发者通过此接口获取日活数和付费率交叉排序由高到低的产品

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/acitvePaysTop

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
date	string	可选	指定获取数据日期，默当前日期认前一天
limit	Int	可选	数据排序TopN，默认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不为空才有

参数	类型	必要性	说明
date	string	必有	指定获取数据日期，默当前日期认前一天
list	Array	必有	产品对象数组，每个数组元素对象包含产品CODE和产品名
productCode	string	必有	产品CODE
productName	string	必有	产品名

19. 第三方社交账号登录

1. 接口目的

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

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/snsLogin

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
openType	int	必传	社交账号类型，填写固定值： 4 微信登录 5 QQ登录 18 阿里云手机一键登录
userOpenId	string	必传	社交账号对应玩家的唯一标识，如微信的openId
access_token	string	必传	社交账号获取玩家的凭证，如微信的授权access_token
appid	string	选传	当openType=5时此字段必传，为QQ开放平台应用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	int	必有	SDK用户uid
username	string	必有	SDK用户名
authToken	string	必有	SDK用户自动登录token串
isGuest	int	必有	是否为游客

20. 获取用户信息

1. 接口目的

开发者通过此接口可获取SDK用户信息

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/queryUser

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
uid	int	必传	SDK账号的uid
sign	string	必传	签名串，算法详见第三章签名算法描述

5. 返回字段

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

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

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

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

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

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

1. 接口目的

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

2. 接口地址

http://quickgame.sdk.quicksdk.net/webOpen/daysReport

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
bdate	string	可选	指定获取数据开始日期，默认当前日期前一天 格式为:YYYY-MM-DD
edate	string	可选	指定获取数据结束日期，默认当前日期 格式为:YYYY-MM-DD
pids	string	可选	指定游戏ID，多个游戏以“,”分隔，默认当前游戏
ccodes	string	可选	指定CPS渠道CODE，多个渠道以“,”分隔，默认不传查询所有渠道
viewType	int	可选	报表查询数据细分维度，取固定值，默认为1 1. 产品维度（返回数据细分到产品维度展示数据） 2. CPS渠道维度（返回数据细分到产品下渠道维度展示数据）
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	必有	产品名
newUser	int	必有	当日注册用户
activeUser	int	必有	当日游戏激活用户
userLogin	int	必有	当日活跃用户
allPay	float	必有	当日玩家充值总额
allPayUser	int	必有	当日付费玩家数
firstPayUser	int	必有	当日新增付费用户数
newPayUser	int	必有	当日新用户付费数
newUserPay	float	必有	当日的新用户充值额
activeUserPay	float	必有	当日激活用户付费额
pageClick	int	必有	当日短链点击数
channelCode	string	可选	产品的子包渠道code，viewType为2时必有
channelName	string	可选	产品的子包渠道名称，viewType为2时必有

22. 获取用户平台币余额

1. 接口目的

开发者通过此接口可获取SDK用户的账号平台币余额

2. 接口地址 

http://quickgame.sdk.quicksdk.net/webOpen/walletInfo

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
uid	int	必传	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	必有	SDK用户的平台币余额

23. 用户账号平台币余额变更

1. 接口目的

开发者通过此接口可给SDK用户的账号平台币余额进行充值或扣除

2. 接口地址 

http://quickgame.sdk.quicksdk.net/webOpen/payToUser

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在QuickSDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
uid	int	必传	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数组包含了用户账号信息

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

参数	类型	必要性	说明
amount	float	必有	变更后的SDK用户平台币余额

24. 自动授权登录

1. 接口目的

开发者通过此接口可以在其网站平台实现免密自动登录用户

2. 接口地址 

http://quickgame.sdk.quicksdk.net/webOpen/autoLogin

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由QuickSDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
authToken	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数组包含了用户账号信息

25. 用户账号游戏专属平台币余额变更

1. 接口目的

开发者通过此接口可给SDK用户的账号专属游戏平台币余额进行充值或扣除

2. 接口地址 

http://quickgame.sdk.quicksdk.net/webOpen/payToGameUser

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
userId	int	必传	SDK账号的uid
amount	float	必传	要变更的金额，正数为充值，负数为扣除
gameCode	string	必传	要变更的游戏，取SDK后台游戏列表的productCode
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	必有	变更后的SDK用户平台币余额

26. 同步区服信息表到SDK系统

1. 接口目的

开发者通过此接口可向SDK同步本游戏的所有区服信息表到SDK

2. 接口地址 

http://quickgame.sdk.quicksdk.net/webOpen/asyGameServer

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
serverId	int	必传	游戏区服ID
serverName	string	必传	游戏区服名称
openTime	string	必传	游戏区服的开服时间，格式为unix时间戳(10位)
serverStatus	int	选传	游戏区服当前状态，取固定值： 1.正常开服中 2.关服中 3.新服 4.火爆 5.负载较高 6.推荐
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时，表示区服同步成功

27. 获取手机号是否绑定账号

1. 接口目的

开发者通过此接口可判断指定手机号是否已经绑定SDK账号

2. 接口地址 

http://quickgame.sdk.quicksdk.net/webOpen/checkPhoneBound

3. 请求方式

POST

4. 参数列表

参数	类型	必要性	说明
openId	string	必传	开放平台开发者身份id，由Quick官方SDK分配
productCode	string	必传	产品CODE，在Quick官方SDK后台获取
channelCode	string	选传	cps分包标识，选传，不传系统默认website
phone	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不为空才有

参数	类型	必要性	说明
bound	int	必有	手机号是否绑定 0 未绑定 1 已绑定

三、签名算法描述

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 $params 需要签名的数据
* @params $openKey SDK分配的加密串
		 * @return	本地计算的md5签名值
   		 */
public function getMd5Sign($params,$openKey){
			ksort($params);
			$signKey = '';
			foreach($params as $key => $val){
				$signKey .= $key.'='.$val.'&';
			}
			$signKey .= $openKey;
			return md5($signKey);
}