API列表
接口分类 |
接口功能说明 |
接口详细文档 |
后台接口 |
查询用户蓝钻信息 |
qqgame_mobile_vip_info |
后台接口 |
确认支付订单 |
qqgame_mobile_confirm_buy |
后台接口 |
判断用户是否登录 |
qqgame_mobile_is_login |
请求url说明
//mobileapi.minigame.qq.com/cgi-bin/api/[api_name]
请求URL的示例
//mobileapi.minigame.qq.com/cgi-bin/api/qqgame_mobile_vip_info
编码形式
支持utf-8和gbk两种, 请求参数中的charset参数指定了请求和响应的字符集(比如: charset=utf-8).
默认charset取值gbk, 非法的charset取值会被认为是gbk
超时时间说明
MobileOpenAPI一般会在50ms以内返回数据,OpenAPI接口机设置的最长超时时间为3s。 开发者可以根据上述说明自行设置OpenAPI调用的超时时间。
请求参数
参数规范
(1)所有参数必须经过url 编码,编码遵守RFC 3986。
(2)接口参数(包括请求特有参数),由2部分组成:游戏请求参数、平台公共请求参数。
(3)发起http请求时,必须指定请求的Referer://mobileapi.minigame.qq.com
请求公共参数
参数名称 |
是否必须 |
参数含义 |
描述 |
gameopenid |
必须 |
string |
与APP通信的用户key。从平台跳转到应用时会调用应用的CanvasURL,平台会在CanvasURL后带上本参数。由平台直接传给应用,应用原样传给平台即可。 根据APPID以及QQ号码生成,即不同的appid下,同一个QQ号生成的OpenID是不一样的。 |
gameopenkey |
必须 |
string |
平台下发用于校验该用户登录态的票据 |
gameappid |
必须 |
unsigned int |
应用的唯一ID。可以通过appid查找APP基本信息,申请接入QQGame平台的时候由平台分配。 |
sig |
必须 |
string |
请求串的签名,以appkey作为密钥,具体签名算法见腾讯开放平台第三方应用签名参数sig的说明。 |
pf |
必须 |
string |
账户类型: "wx"代表微信帐号 "qq"代表qq帐号
|
ts |
|
uint32 |
UNIX时间戳(从格林威治时间1970年01月01日00时00分00秒起至现在的总秒数) |
ver |
|
int |
API版本号(取值为:1, 2, 3…)
|
charset |
|
string |
指定请求及响应的字符集, 可选取值为gbk和utf-8, 默认值为gbk, 其他非法取值也认为是gbk |
seq |
|
int |
回传字段 |
公共返回参数说明
公共返回参数如下,其余返回参数由各个API自行定义,请参考各OpenAPI的说明
参数名称 |
描述 |
result |
返回码。具体返回码含义详见下文。 |
resultstr |
如果错误,返回错误信息。 |
seq |
回传字段
|
pf |
回传账户类型 |
公共返回码
result= 0: 正确返回,其他情况为异常。
错误返回示例
数据结构如下:
{
"result":1000002,
"resultstr":"您提交的参数不正确,请重新操作!",
"seq":0,
"pf":"qq"
}
不同的异常,错误码不同。