QQ空间活动平台前后端交互文档Word格式.docx

资源描述

QQ空间活动平台前后端交互文档Word格式.docx

《QQ空间活动平台前后端交互文档Word格式.docx》由会员分享，可在线阅读，更多相关《QQ空间活动平台前后端交互文档Word格式.docx（32页珍藏版）》请在冰豆网上搜索。

QQ空间活动平台前后端交互文档Word格式.docx

JavaScript运行环境域名

默认值为qq.，该值必须允许域名的白名单内，白名单在平台内设置。

script

是否加上<

script>

标签

只要设置该参数，不管值如何，均加上<

unicode

是否使用UNICODE编码输出

只要设置该参数，不管值如何，均使用UNICODE编码输出

例如：

act.qzone.qq./user/profile.php?

act_id=10029&

qq=12345&

callback=MyCallback&

domain=qq.&

script&

uincode

document.domain=”qq.”;

MyCallback（$obj）<

/script>

其中$obj是unicode编码的json字符串

3通用异常处理

当平台的PHP脚本遇到异常或错误时，会返回一个统一的错误格式数据，示例如下：

当设置了callback参数时：

JsonCallback（{"

error"

type"

4103,"

msg"

QQ号格式有错"

errcode"

4103}}）;

以树型显示的JSON数据：

当没有callback参数时：

err"

}

其中err为错误代码，msg为错误信息。

4身份验证

用户注册，资料编辑，投票均需要用户在已登录情况下才能操作。

登录态使用公司统一的社区登录系统ptlogin2，平台根据保存在cookies中的资料取得用户登录态并鉴别身份。

5免费注册接口

5.1接口地址

act.qzone.qq./user/freereg.php

5.2参数说明

方式

值

act_id

GET

活动ID，在活动平台管理端创建活动时生成。

如10029。

整数

用户资料

POST

用户资料参数由双方根据活动实际需要事先确定好注册页面上需要用户填写的项目及格式，然后由平台方提供具体的参数名及参数说明，详情见具体活动的开发说明。

多种取值

5.3返回结果

A.执行成功：

返回用户资料（JSON格式）

返回数据包括用户基本资料（平台通用）及用户特定资料（针对不同活动专门设置），其中平台通用的用户数据及格式说明如下：

字段名

类型

int

活动ID，同一活动所有用户统一一个活动ID

用户QQ号码

reg_time

注册该活动的时间，unix时间戳

need_audit

是否需要审核：

1=需要，0=不需要

is_display

是否显示：

1=显示，0=不显示，不显示的用户不会出现在任何列表中，在个人页也不能查看该用户的信息。

edit_count

资料编辑次数

edit_time

最后一次编辑资料的时间，unix时间戳

need_audit_m

任务中的用户否需要审核，32位整数，每一位代表一个任务，目前从低位算起，0-4位分别代表任务1-5

is_display_m

任务中的用户否需要显示，32位整数，每一位代表一个任务，目前从低位算起，0-4位分别代表任务1-5

edit_count_0

任务1编辑次数

edit_count_1

任务2编辑次数

edit_count_2

任务3编辑次数

edit_count_3

任务4编辑次数

edit_count_4

任务5编辑次数

edit_time_0

任务1最后一次编辑时间,unix时间戳

edit_time_1

任务2最后一次编辑时间,unix时间戳

edit_time_2

任务3最后一次编辑时间,unix时间戳

edit_time_3

任务4最后一次编辑时间,unix时间戳

edit_time_4

任务5最后一次编辑时间,unix时间戳

sort0

自定义排序数据0

sort1

自定义排序数据1

sort2

自定义排序数据2

sort3

自定义排序数据3

sort4

自定义排序数据4

sort5

自定义排序数据5

sort6

自定义排序数据6

sort7

自定义排序数据7

sort8

自定义排序数据8

sort9

自定义排序数据9

B.执行失败：

返回如前面所述的统一的错误格式。

出差的原因包括但不限于：

1.活动未开始，或已经结束，或活动暂停。

2.取登录态失败。

3.用户未开通QQ空间。

4.注册资料错误。

5.4调用示例

注册页面示例：

formid="

form1"

action="

act.qzone.qq./user/freereg.php?

domain&

callback=parent.jsonCallBack&

act_id=10029"

method="

post"

div>

：

inputname="

name"

type="

text"

手机：

mobile"

地址：

addr"

/div>

/form>

6注册预检查接口

检查用户是否可以注册，是否已注册，需要登录态，及加载活动配置。

6.1接口地址

act.qzone.qq./user/precheck_reg.php

6.2参数说明

活动ID

6.3返回结果

A状态正常，可以注册，返回JSON格式数据：

code=0

B异常状态，不可以注册，返回JSON格式数据，见上述的通用异常处理说明。

7取用户个人资料数据接口

7.1接口地址

act.qzone.qq./user/profile.php

7.2参数说明

参赛用户QQ

整数，留空为取当前已登录用户QQ

7.3返回结果

A执行成功，返回跟免费注册接口一样的数据格式。

B执行失败，参考通用异常处理说明。

异常的原因可能但不限于：

1.活动未开始，已结束或暂停。

2.用户没有注册，或未审核，或审核不通过。

（在主人态模式下可查看未审核用户资料）

3.没有指定用户并且没有登录。

（或已登录的用户没有注册。

）

8登录态检查接口

8.1接口地址

act.qzone.qq./user/status.php

8.2参数说明

没有参数，根据用户cookies取得登录态信息。

8.3返回结果

返回JSON格式数据

用户QQ号码，0表示未登录用户

nickname

str

用户昵称

9取好友活动信息接口

9.1接口地址

act.qzone.qq./user/friend.php

9.2参数说明

fqq

查询的好友QQ

整数，留空为取当前已登录用户的QQ好友列表中参与活动的那部分好友

9.3返回结果

只返回注册了活动的好友数据

2.用户没有登录或者用户没有注册活动

3.查询的QQ号码不是登录用户的QQ好友或者查询的QQ号码是登录用户的好友但并没有注册活动

9.4调用示例

act.qzone.qq./user/friend.php?

act_id=10064

返回的是登录用户的所有参与10064活动的QQ好友数据列表

act_id=10064&

fqq=100322&

fqq=842222

返回的是100322和842222两位用户的数据列表，前提是这两个号码都是登录用户的QQ好友

10QQ空间挂件接口

10.1接口地址

act.qzone.qq./user/item.php

10.2参数说明

整数，不可空

10.3返回结果

11批量取昵称接口

11.1接口地址

act.qzone.qq./user/nickname.php

11.2参数说明

uins

用户QQ号码集合

字符串，形如17777,11113,12321321

即每个QQ号码之间以”,”隔开

11.3返回结果

A执行成功，返回数据格式形如：

data"

1000001"

test"

10003"

test2"

}}

1.QQ号码集合里有不符合要求的QQ号码，比如格式不对。

2.缺少uins参数

12编辑资料接口

12.1接口地址

act.qzone.qq./user/edit.php

12.2参数说明

edit_p

GET

编辑任务。

该参数存在且满足值域时表示提交任务，不存在时或者不满足值域时则表示修改个人资料

整数，0-4

12.3返回结果

A.执行成功：

编辑个人资料

Is_display

提交任务

任务中的用户否需要审核，32位整数，每一位代表一个任务，目前从低位算起，0-4位分别代表任务1-5。

Is_display_m

任务中的用户否需要显示，32位整数，每一位代表一个任务，目前从低位算起，0-4位分别代表任务1-5。

1=显示，0=不显示，不显示的用户不会出现在任何列表中，在个人页也不能查看该用户的信息

1.没有登录或者没有注册

2.没有启用修改功能或者修改次数已达上限

3.对不允许修改的用户资料进行修改

13编辑资料预检查接口

13.1接口地址

act.qzone.qq./user/precheck_edit.php

13.2参数说明

13.3返回结果

返回数据包括用户基本资料（平台通用）、用户的数据资料集合（针对不同活动专门设置）以及用户可以修改的数据字段配置集合（针对不同活动专门设置），形如：

{code:

0,’user_conf’:

{xxx},’data’:

{xxxx}}

其中user_conf是用户信息里可以修改的数据字段配置集合,data是用户的数据资料集合（包含平台通过数据）。

关于平台通用的数据及格式说明，返回跟免费注册接口一样的数据格式。

B.执行失败，参考通用异常处理说明。

2.活动未开始或者已经结束

3.用户没有被审核通过

5.达到修改上限或者没有启动修改功能

14免费投票接口

14.1接口地址

act.qzone.qq./vote/freevote.php

14.2参数说明

整数，>

10000

verifycode

验证码

字符串，一般是4位但不仅限于4位

player

参赛选手QQ号码（即得票者QQ号码）

votecount

投票票数

非0正整数

word

投票留言

字符串，可选项，视实际需要而定

14.3返回结果

[{"

act_id"

10056,"

act_title"

冰爽七喜，一点就透"

uin"

17774614,"

player"

1963169,"

votecount"

1,"

投票成功!

}]}

act_title

活动标题

uin

投票者的QQ号码

得票者的QQ号码

本次投票的票数

msg

提示文字

1.参数不全

2.没有登录

3.投票对象即得票者没有注册活动或在等待审核、审核未通过

4.投票者的免费投票操作达到了限制范畴（限制功能由后台配置）

5.没有启用免费投票功能（启用投票功能由后台配置）

15付费投票接口

15.1接口地址

act.qzone.qq./vote/payvote.php

15.2参数说明

type

付费投票类型

1.单点付费投票

2.礼包付费投票

整数,>

votepkgcount

礼包个数

整数，当且仅当type=2时有效

paytype

付费类型

=1，Q币

=2，Q点

=3，优先Q币不足用Q点

=4，优先Q点不足用Q币

付费投票留言

15.3返回结果

price

本次投票所付费用

input_data

前端传入的所有数据集合

votenum

4.投票者的付费投票操作达到了限制范畴（限制功能由后台配置）

5.没有启用付费投票功能（启用投票功能由后台配置）

6.账户余额不足

16投票预检查接口

16.1接口地址

act.qzone.qq./vote/votecheck.php

16.2参数说明

16.3返回结果

A.执行成功，返回JSON格式的数据：

形如

{‘data’:

{‘act_id’:

10029,’act_title’:

’test’,’qq’:

100037,’uin’:

{xxx},’player’:

{xxx},’act_conf’:

{xxx},’limits’:

{xxx}}}

所查询的QQ号码

投票者信息

投票对象信息

act_conf

最热粉丝榜

limits

投票限制

uin和player的数据格式

QQ号码

name

Qzone昵称

city

城市达人级别

yellow

黄钻级别

act_conf和limits的配置请详见活动配置文档

1.未登录

2.投票对象没有注册活动或者没有通过审核、等待审核

17投票粉丝接口

17.1接口地址

act.qzone.qq./vote/votefans.php

17.2参数说明

17.3返回结果

100037,’fans’:

{‘faith_fans’:

[],’new_fans’:

[]}}}

fans

粉丝榜具体信息的根节点

new_fans