更新日期:2024-04-24PC游戏开放平台接入文档
1.1. 接口目的
开发者通过此接口让其平台用户在自己网站上登录游戏账号,获取游戏账号信息,适用于有自己的登录界面的情况。
1.2. 接口地址
1.3. 请求方式
POST
参数 |
类型 |
必要性 |
说明 |
openId |
string |
必传 |
开放平台开发者身份id,由Quick官方SDK分配 |
productCode |
string |
必传 |
产品CODE,在Quick官方SDK后台获取 |
channelCode |
string |
选传 |
cps分包标识,选传,不传系统默认website |
username |
string |
必传 |
登录用户名 |
password |
string |
必传 |
登录密码,由原始密码经过32位md5编码后组成 |
sign |
string |
必传 |
签名串,算法详见第三章签名算法描述 |
1.5. 返回字段
例2 {"status":true,"message":"","data":[]}
参数 |
类型 |
必要性 |
说明 |
status |
bool |
必有 |
接口验证状态,若通过验证为true,否则为false |
message |
string |
必有 |
Status为false时,message有值,为错误提示语 |
data |
array |
可为空 |
如果status为true时,data数组包含了用户账号信息 |
2.1. 接口目的
如果要使用SDK的登录界面,开发者通过此接口构造登录页面地址。
2.2. 接口地址
2.3. 请求方式
POST
参数 |
类型 |
必要性 |
说明 |
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/checkToken 接口验证查询玩家信息,主看下一章节(3.获取用户信息)。
PC或其他应用可监听webview URLChange事件,当URL改变为传入的successUrl时,截获URL并获取GET参数。
接口会返回JSON格式字串,形如:
{"status":true,"data":{"loginUrl":"http://quickgame.sdk.quicksdk.net/open/oauth?openId=ABC123&successUrl=http://www.quicksdk.cn/game.php&productCode=855923333115229372776686527722122&channelCode=website&sign=578e8f2015317a9bcb1b833fdfcfbc5b"},"message":"请求成功"} 说明:返回的JSON结构体里,data.loginUrl即为当前接口返回的完整登录url |
登录成功后跳转successUrl附带的参数如下
参数 |
类型 |
必要性 |
说明 |
uid |
bool |
必有 |
玩家uid,获取到该uid后,应使用authToken查询用户,验证该uid是否与authToken对应的uid一致。 |
username |
string |
必有 |
玩家用户名 |
timeLeft |
int |
必有 | 玩家可游戏时间,单位秒,客户端可设置定时器,在该秒数后注销登录 |
authToken |
array |
必有 |
为防止来自URL的信息被篡改,游戏获取到uid、authToken后应调用 webOpen/checkToken 接口验证authToken对应的uid是否匹配 |
3.1 接口目的
开发者通过此接口验证用户信息
3.2 接口地址
3.3 请求方式
POST
3.4 参数列表
参数 |
类型 |
必要性 |
说明 |
openId |
string |
必传 |
开放平台开发者身份id,由Quick官方SDK分配 |
productCode |
string |
必传 |
产品CODE,在Quick官方SDK后台获取 |
channelCode |
string |
选传 |
cps分包标识,选传,不传系统默认website |
authToken |
int |
必传 |
登录成功回传的authToken |
sign |
string |
必传 |
签名串,算法详见第三章签名算法描述 |
3.5 返回字段
例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用户名 |
mobile |
string |
必有 |
SDK用户绑定的手机号 |
isGuest |
int |
必有 |
是否为游客 |
regTime |
int |
必有 |
SDK用户注册时间,格式为时间戳 |
4.1 接口目的
开发者通过此接口让其平台用户在自己网站平台上能直接获取此用户某条订单详情
4.2 接口地址
4.3 请求方式
POST
4.4 参数列表
参数 |
类型 |
必要性 |
说明 |
openId |
string |
必传 |
开放平台开发者身份id,由Quick官方SDK分配 |
productCode |
string |
必传 |
产品CODE,在Quick官方SDK后台获取 |
channelCode |
string |
选传 |
cps分包标识,选传,不传系统默认website |
amount | float | 必传 | 将要下单的金额,单位元 |
userId |
string |
必传 |
sdk登录成功返回的uid |
cpOrderNo |
string |
必传 |
游戏订单号 |
orderSubject | string | 必传 | 商品描述 |
goodsName |
string |
必传 |
商品名称 |
roleName | string |
必传 |
角色名 |
roleLevel |
float |
必传 |
角色等级 |
serverId |
string |
必传 |
区服id |
serverName |
string |
必传 |
区服名称 |
extrasParams |
string |
选传 |
透传参数,通常为研发需要的特定参数,sdk会原样回调。 |
callbackUrl |
string |
选传 |
支付成功回调结果的地址 |
sign |
string |
必传 |
签名串,算法详见第三章签名算法描述 |
4.5 返回字段
例2 {"status":true,"message":"","data":[]}
参数 |
类型 |
必要性 |
说明 |
status |
bool |
必有 |
接口验证状态,若通过验证为true,否则为false |
message |
string |
必有 |
Status为false时,message有值,为错误提示语 |
data |
array |
可为空 |
如果status为true时,data数组包含了订单详细信息 |
接口会返回JSON格式字串,形如:
{"status":true,"data":{"payUrl":"http://quickgame.sdk.quicksdk.net/payH5/payCenter?clientLang=zh-cn&data=zzk4puUOWCH13TXOOb6AuOhAiGb/slIUrw2+EURpRinTg1ubbYeMjLBb+Z3cVnn0AulLuWVOud86+EudHyYqX3oililkAcDT5G2+E9Og4U8=&sign=ce30d0a71aa2584bb8ee91921f4dca57"},"message":"请求成功"} 说明:返回的JSON结构体里,data.payUrl即为当前接口返回的完整支付页面url |
5.1 接口目的
开发者通过此接口获取个人中心访问链接
5.2 接口地址
5.3 请求方式
POST
5.4 参数列表
参数 |
类型 |
必要性 |
说明 |
openId |
string |
必传 |
开放平台开发者身份id,由Quick官方SDK分配 |
productCode |
string |
必传 |
产品CODE,在Quick官方SDK后台获取 |
channelCode |
string |
选传 |
cps分包标识,选传,不传系统默认website |
authToken |
int |
必传 |
登录成功回传的authToken |
sign |
string |
必传 |
签名串,算法详见第三章签名算法描述 |
5.5 返回字段
例2 {"status":true,"message":"","data":[]}
参数 |
类型 |
必要性 |
说明 |
status |
bool |
必有 |
接口验证状态,若通过验证为true,否则为false |
message |
string |
必有 |
Status为false时,message有值,为错误提示语 |
data |
array |
可为空 |
如果status为true时,data数组包含了用户账号信息 |
注:以下参数只有当status为true且data不为空才有
参数 |
类型 |
必要性 |
说明 |
userCenterUrl |
string |
必有 |
个人中心的访问链接 |
李先生:13880511661
QQ:48157910
赵先生:15390049857
QQ:1077535763
孙女士:13551010407
QQ:1799614139
QQ群:698731538