QQ游戏 开放平台

欢迎来到QQ游戏开放平台 管理中心 | 注册 | 开发者论坛
前端接口调用说明

名词解释

appid 应用申请接入开放平台时得到的应用ID, 如果qqgame和开放平台同时分配了appid,则使用开放平台分配的appid 对qqgame内部app,如英雄杀,使用gameid即可

沙箱环境与正式环境 沙箱环境是为了开发与调试所提供的测试环境,它与正式环境互相隔离,但具有正式环境几乎完全相同的功能。沙箱环境通过指定ip调用相应接口,正式环境可以通过域名或者ip调用对应接口。此外,在沙箱环境中产生的数据与正式环境相互隔离。

回调函数 在相应事件(如:成功调用接口、关闭弹窗等)触发时调用的函数。

调用说明

启动页面配置

游戏方需提供默认启动页面(只能提供一个)配置到QQGame开发平台,配置后大厅启动游戏时会通过snsbrowser浏览器自动拉起配置的页面。
说明:如果游戏方有多种功能页面需要通过默认启动拉起,可以通过透传参数来判断,做相应的跳转即可。窗体结构如下:

APP接入页面均以iframe形式内嵌在qqgame开放平台框架页中,js API定义在框架页中,接入页面通过引入js库调用js API,所以调用Js接口时程序会与框架页(父页面)交互,所以需通过访问//qqgameplatcdn.qq.com/social_hall/app_frame/?appid=$appId或//minigame.qq.com/plat/social_hall/app_frame/?appid=$appId 进行调试,不能直接访问内部页面进行接口调试。

启动页面说明

页面必须包含QQGame开放平台提供的js库,才能调用各js接口,如下:
//qqgameplatcdn.qq.com/social_hall/js/jquery.js
//qqgameplatcdn.qq.com/social_hall/js/jquery.pm.js
//qqgameplatcdn.qq.com/social_hall/app_frame/qqgamelib.js
游戏方可以直接在页面头部加载上面的js库,如下图:

也可以为性能考虑,在需要调用js接口前,动态加载上面的js库,不做约束。

域名检查

首先保证应用所在的域名是app$appid.qqgameapp.com或s\d\d.app$appid.qqgameapp.com,或者为qqgame.app$appid.twsapp.com, 或*.myqcloud.com, $appid为开放平台部分配的应用接入id,\d代表任一0~9整数。 多区多服应用域名支持app$appid.openwebgame.qq.com

接入QQGame

APP接入页面均内嵌在开放平台接入页面中,Javascript API定义在父页面中,各APP通过回调函数满足定制需求,调用API前需要提供域名到QQGame平台,并在平台发布白名单后在大厅测试专区中,使用测试号码进行调试。