更新日期:2024-05-17PC游戏开放平台接入文档
Quick提供了3种接入方式,具体区别详见文档:PC游戏接入方式说明
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 |
必传 |
签名串,算法详见第7章签名算法描述 |
1.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用户注册时间,格式为时间戳 |
authToken | string | 必有 | 用户授权token |
2.1 接口目的
为了简化登录流程,本接口提供了新的登录窗口接入方式,游戏使用Quick登录界面或者登陆器调此接口
2.2 接口地址
2.3 请求方式
GET
参数 |
类型 |
必要性 |
说明 |
openId |
string |
必传 |
开放平台开发者身份id,由Quick官方SDK分配 |
productCode |
string |
必传 |
产品CODE,在Quick官方SDK后台获取 |
channelCode |
string |
选传 |
cps分包标识,选传,不传系统默认website |
successUrl |
string |
必传 |
完成登录后的回调地址 |
cancalUrl | string | 可选 | 取消时回调的URL |
noPhoneLogin | string | 可选 | 值为1时不需要手机登录方式 |
noQrLoginstring | string |
可选 |
值为1时不需要扫码登录方式 |
noCodeImg |
string |
可选 |
值为1时不需要验证码 |
stopClose |
string |
可选 |
值为1时隐藏关闭按键 |
noRegFun |
string |
可选 |
值为1时关闭注册 |
theme |
string |
可选 |
窗口风格参数,共有模板可选web,gameLauncher,android,dark,私有界面风格请联系QuickSDK定制 |
注:登录页通常会100%铺满webview的尺寸,故游戏的webview多大,授权网页将等同其大小。
游戏可自定义webview尺寸。
作为建议,我们建议不同theme的尺寸如下:
web风格:470x475 (默认使用web风格)
androrid风格:470x535
gameLaucher风格:510x460
dark风格:470x510 (注意,若使用dark风格,建议将webview设为透明状态以提高显示效果)
2.5 返回字段
没有返回参数,直接进入登录页面窗口
如果传入参数successUrl则会在些url上拼接登录成功后的uid username authToken timeleft等相关参数
说明:authToken的获取来源可以是章节1或者是章节2中的使用的登录方式。另外有一种是通过登录器的启动参数获取,前提是登录器已经是登录状态的情况。此时启动游戏则会在游戏主程序上添加三个启动参数(uid authToken channelCode),默认3个参数,不排除后续根据需要添加。研发则可以通过主程序main函数进行获取。
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 |
必传 |
签名串,算法详见第7章签名算法描述 |
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 |
deviceId |
string |
必有 |
设备信息设备号 |
productId |
string |
必有 |
产品id |
tokenIp | string |
必有 |
ip |
token | string | 必有 | token |
timeleft |
int |
必有 |
未成年可游戏的时长 |
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 |
必传 |
签名串,算法详见第7章签名算法描述 |
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 参数列表
参数 |
类型 |
必要性 |
说明 |
appProduct |
string |
必传 |
产品CODE,在Quick官方SDK后台获取 |
channelCode |
string |
选传 |
cps分包标识,选传,不传系统默认website |
authToken |
string |
必传 |
登录成功回传的authToken |
5.5 返回字段
没有返回参数,直接进入个人中心页面窗口
5.1 接口目的
获取开放平台授权accessToken用于相关接口访问
6.2 接口地址
6.3 请求方式
POST
6.4 参数列表
参数 |
类型 |
必要性 |
说明 |
openId |
string |
必传 |
开放平台参数openId |
openKey |
string |
必传 |
开放平台参数openKey |
6.5 返回字段
例2 {"status":true,"message":"","data":[]}
参数 |
类型 |
必要性 |
说明 |
status |
bool |
必有 |
接口验证状态,若通过验证为true,否则为false |
message |
string |
必有 |
Status为false时,message有值,为错误提示语 |
data |
array |
可为空 |
如果status为true时,data数组包含了用户账号信息 |
注:以下参数只有当status为true且data不为空才有
参数 |
类型 |
必要性 |
说明 |
accessToken |
string |
必有 |
授权accessToken |
第二步:使用上述参数构造签名串比如key1=val1&key2=val2&key3=val3依次类推,假如得到签名串StringA,注意key与val都是urldecode之后的值。
第三步:拼接最终的签名串StringB = StringA + "&" + openKey(通过开发者平台获取)。
第四步:使用md5计算第三步签名串哈希值即为:sign=md5(StringB)。
注意:文档中据说+号为字符拼接符号,各开发程序有不同。
李先生:13880511661
QQ:48157910
赵先生:15390049857
QQ:1077535763
孙女士:13551010407
QQ:1799614139
QQ群:698731538