应用联调指引

特别提示
本文档仅适用于应用接入腾讯朋友,QQ空间,微博平台的联调。
如果您的应用通过腾讯开放平台接入3366平台,则请参考3366平台应用联调指引

目录

1. 应用联调总体说明

开发者在将应用接入到腾讯开放平台的各个业务平台(腾讯朋友,QQ空间,微博等)时,需要进行应用联调,包括:
-应用前台展现是否适应平台的iframe框架;
-应用是否正确地使用了平台OpenAPI;
-验证好友邀请等需要调用前端FusionAPI的功能。

腾讯开放平台为上线前的应用提供了应用测试环境,应用测试环境中应用运行在平台正式框架下,用户体验和平台正式环境完全相同,唯一区别只在于应用是否在应用中心可见。
开发者在创建应用后就可以在测试环境中预览和调试自己的应用,调试成功后再将应用提交,以加快应用接入平台的时间。
应用上线后,开发者再不能进入测试环境进行应用调试。

2. 调试前的准备

2.1 设置调试者QQ号

登录open.qq.com,进入管理中心首页,选择1个应用进入,可看到“应用管理”tab,在“应用管理”tab的“应用调试者”页面,即可添加或修改调试者QQ号码。
调试者可以通过应用平台地址访问您的应用,其体验与正式上线后一样。
test_env_8.png

2.2 完善应用基本信息、图标素材及平台信息

完善应用基本信息、图标素材及平台信息有助于联调时顺利预览应用。
登录open.qq.com,进入管理中心首页,选择应用进入,可看到“应用管理”tab,在“应用管理”tab下,开发者可以完善基本信息、图标素材及平台信息。

详细说明如下:
1. 在“基本信息”页面,填写应用基本信息(每个字段的说明在问号图标中有详细说明),请按页面上的要求填写。
2. 在“图标素材”页面,添加应用图标(每个图标的用途在问号图标中有详细说明),请按页面上的要求添加相应的图标。
3. 在“平台信息”页面,填写应用开发地址。这里填写任意的地址都可以进行调试,但是建议填写应用的实际调用地址,应用开发地址有如下说明:
-腾讯托管应用:平台自动为应用生成入口域名,如要修改,只能在入口域名后加详细地址。
如果是多区多服应用,会自动将域名自动匹配至选区配置页,不允许修改。
如果填写了任意的开发地址,只要点击“恢复默认”按钮,即会恢复为平台自动生成的域名。
-非腾讯托管应用:应用的实际调用地址,由开发者填写。

应用基本信息等页面如下图所示:
startup_guide_22.png

3. 调试内容及调试方法说明

3.1 调试内容说明

阶段 调试内容 说明 相关文档
应用上线前 API调试 应用上线前必须完成。

接入QQ空间、朋友、微博平台的应用,可以调用腾讯开放平台提供的OpenAPI以及FusionAPI来实现各种平台功能。
开发者可以使用测试域名以及联调工具集进行OpenAPI以及FusionAPI的调试。

(1)API列表

(2)API调试说明

前台展现调试 应用上线前必须完成。

接入QQ空间、朋友、微博平台的应用,其图标素材必须符合腾讯开放平台的前端页面规范。
应用处于不同状态时进行应用预览的方式不同,

(1)前端页面规范

(2)应用预览:
-开发中:使用“开发者”应用进行预览
-符合接入规范后:使用应用平台地址进行预览

 
应用上线前/后 支付功能调试 应用上线前或上线后完成都可。

应用可申请接入腾讯支付系统(应用上线前或上线后都可以接入支付,只要签订了收益相关补充协议,即可在腾讯开放平台管理中心申请接入支付)。
开发者必须按照腾讯开放平台提供的支付接入流程进行支付的接入,支付功能开发和联调。

支付接入流程
黄钻特权功能调试 接入腾讯支付系统时,必须接入黄钻特权体系。

开发者必须按照腾讯开放平台提供的黄钻特权内容规范进行黄钻特权内容的开发和调试。

接入黄钻体系
 
应用上线后 营销功能调试 应用上线支付后,可以接入营销体系。

开发者请按照腾讯开放平台提供的营销开发说明进行营销功能的开发和调试。

自助营销平台说明
腾讯罗盘调试 应用上线后,可以接入腾讯罗盘。

开发者请按照腾讯开放平台提供的腾讯罗盘数据上报说明进行功能的开发和调试。

腾讯罗盘简介

3.2 使用测试域名以及联调工具集进行API联调

1. 关于设置OpenAPI超时时间的说明
OpenAPI一般会在50ms以内返回数据,最长超时时间为3s。
开发者可以根据上述说明自行设置OpenAPI调用的超时时间。


2. 关于测试域名
进行OpenAPI联调时,需要使用测试域名。OpenAPI V3.0 测试域名:openapi.sparta.html5.qq.com。

使用测试域名时有如下注意事项:
(1)测试环境IP仅针对调试者QQ号有用,即只有调试者QQ号对应的OpenID会通过验证。
非调试者QQ号将会返回-64的错误。
(2)测试环境IP调用有频率限制,如果超出频率限制将会出现提示。
(3)Non-hosting应用由于不能调用好友关系链OpenAPI,因此不能测试好友关系链OpenAPI。
(4)支付类OpenAPI必须在应用申请接入支付后才能调用测试域名进行联调。
(5)将应用部署到正式环境中时,需要将OpenAPI的测试域名替换为正式域名(正式域名详见:API3.0文档#OpenAPI V3.0调用说明)。


3. 关于联调工具集
腾讯开放平台为开发者提供了联调工具集(open.qq.com/tools),用于OpenAPI以及FusionAPI的联调。
使用联调工具集的方法和注意事项:
(1)登录open.qq.com/tools,即可访问调试工具集。
(2)目前调试工具集只对应用的创建者开放,即如果登录QQ号是应用的协作者,那么使用OpenAPI联调工具时,不能拉取到该应用的APPID。后续工具会支持协作者。
test_env_14.png

3.3 开发中的应用,使用“开发者”应用进行预览

开发者需要预览应用以便查看应用前台展现是否适应平台的iframe框架,以及验证一些需要进行交互的操作(例如好友邀请)。
开发中的应用,只能通过“开发者”应用来预览。
此时开发者可以随时修改应用相关信息以及应用程序逻辑,然后预览调整信息后的效果。

使用开发者前需要关注的注意事项:
对于微博平台,跳转URL中带的pf值为tapp。如果您的应用是从微博开放平台(http://open.t.qq.com )接入而不是从腾讯开放平台(http://open.qq.com )接入,则开发者应用不支持您的应用在微博平台的预览。

进入“开发者”应用有2种方式:
方式1:在管理中心中点击“调试”按钮进入“开发者”
详细步骤如下:
1. 登录open.qq.com后进入管理中心,选择1个未上线的应用进入,在“应用管理”tab下的“平台信息”页面,可看到“调试”按钮,如下图所示:
test_env_11.png
2. 点击“调试”按钮即进入“开发者”应用,如下图所示:

test_env_12.png

3. 在“开发者”中,选择1个开发中的应用,点击进入后会即会跳转到应用。跳转时,会引用应用的开发地址,如下图所示:
(注意,跳转后地址栏显示的是“开发者”应用的平台地址,内框引用的才是应用开发地址。
应用开发地址由应用自己在上面第1步所示图中的“应用开发地址”输入框中指定)
test_env_13.png

方式2:在应用中心中搜索“开发者”应用,安装后即可进入
1. 在平台的应用中心搜索“开发者”应用并安装。目前腾讯朋友,QQ空间,腾讯微博平台上都已经提供了“开发者”应用。如下图所示:
test_env_7.png
2. 进入“开发者”应用后跳转到应用的方式与上面方式1的一样,这里不再重复。

3.4 符合接入规范的应用,使用应用平台地址进行预览

应用符合接入规范,会为应用生成应用平台地址,然后开发者以及应用的调试者都可以通过应用平台地址预览应用。
此时开发者可以随时修改应用相关信息(有些信息修改后立即生效,有些信息修改后需要符合接入规范后才能生效),然后预览调整信息后的效果。

有2种方式可以获取应用平台地址,并通过应用平台地址进行预览:
方式1:在管理中心查看应用平台地址,并通过平台地址进行预览
这种方式针对已经符合接入规范的应用(包括未上线和已上线的),详细步骤如下:
1. 登录open.qq.com,进入管理中心首页,选择1个已经符合接入规范的应用进入,可看到“应用管理”tab,在“应用管理”tab的“平台信息”页面,选择对应的平台,即可看到“平台地址”,如下图所示:
test_env_9.png

2. 您可以:
(1)点击“调试”按钮,然后进入应用;
(2)也可以直接在浏览器地址栏输入应用平台地址进入应用;
(3)此外,开发者可以复制应用的平台地址给调试者QQ号,这些调试者可以通过应用平台地址进入应用。
在朋友和空间平台,只有您和您的调试者才能使用应用平台地址访问未上线应用;在微博平台,您可使用应用平台地址在全部用户间传播您的应用。


方式2:直接在地址栏输入应用平台地址进行预览
这种方式仅针对已经正式上线,在应用中心可见的应用。
在空间、朋友、微博等平台的应用中心中点击该应用,进入应用后,在地址栏显示的即应用平台地址,如下图所示:
example_appurl.jpg

3.5 上线后的应用联调

应用上线后,其程序中调用的是正式环境的OpenAPI。所有的修改立刻现网生效,外网用户可见。
为了让上线后的应用也能够进行应用联调,开放平台的“开发者”应用支持上线后的应用联调。

开发中的应用,只能通过“开发者”应用来预览。
此时开发者不能在管理中心中修改应用相关信息,但是如果应用程序逻辑修改了,则可以通过“开发者”应用来预览效果。

使用开发者前需要关注的注意事项:
对于微博平台,跳转URL中带的pf值为tapp。如果您的应用是从微博开放平台(http://open.t.qq.com )接入而不是从腾讯开放平台(http://open.qq.com )接入,则开发者应用不支持您的应用在微博平台的预览。

上线后的应用通过“开发者”预览应用有2种方式:
方式1:在管理中心中点击“调试”按钮,进入“开发者”,调用“调试地址”预览应用
详细步骤如下:
1. 登录open.qq.com后进入管理中心,选择1个已上线的应用进入,在“应用管理”tab下的“平台信息”页面,可看到“调试”按钮,如下图所示:
test_env_15.png
2. 点击“调试”按钮即进入“开发者”应用,如下图所示:

test_env_16.png

3. 在“开发者”中,选择1个已上线的应用,点击进入后会即会跳转到应用。跳转时,会引用调试地址,如下图所示:
(注意,跳转后地址栏显示的是“开发者”应用的平台地址,内框引用的才是调试地址。
该调试地址由应用自己指定,点击上面第1步图中红框标注的“编辑”按钮可随时编辑该地址)
test_env_17.png

方式2:在应用中心中搜索“开发者”应用,安装后即可进入
1. 在平台的应用中心搜索“开发者”应用并安装。目前腾讯朋友,QQ空间,腾讯微博平台上都已经提供了“开发者”应用。如下图所示:
test_env_7.png
2. 进入“开发者”应用后跳转到应用的方式与上面方式1的一样,这里不再重复。

以上信息是否解决您的问题?

Copyright © 1998 - 2017 Tencent. All Rights Reserved.

腾讯公司 版权所有

有问必答 返回顶部