用户反馈数据 API
说明
兔小巢支持通过 API 接口获取产品的用户反馈,以便产品做后续处理。
1.获取密钥和ID
1.管理员登录 PC 管理后台,点击左上角产品 icon,在产品设置中获取 private_key
(也叫密钥)和产品 ID。
2.请求第一页示例(密钥:tucao123,产品 ID:1234,仅参考数据)
以 curl
命令发起 http
GET
请求curl https://txc.qq.com/api/v1/1234/posts -H "Timestamp: 1539854769" -H "Signature: ad22dba05d9cdf7876a15ecf58861d1c"
其中:
参数名 | 类型 | 说明 |
---|---|---|
Timestamp | string | HTTP HEADER 头字段,当前时间的 unix timestamp 10位数字格式的字符串 |
Signature | string | HTTP HEADER 头字段,md5(str(Timestamp)+str(密钥)) 字符串格式 |
3.请求翻页示例(密钥:tucao123,产品 ID:1234,仅参考数据)
翻页链接由返回值中的next_page_url决定,请求用户反馈数据的条数由count字段决定
每次翻页请求时,需要更新时间戳及签名,以避免时间戳过期。
举个例子:
next_page_url为:/api/v1/1234/posts?max_id=153985337910779971
那么第二页的请求链接为:
`https://txc.qq.com/api/v1/1234/posts?max_id=153985337910779971 -H "Timestamp: 1539854769" -H "Signature:ad22dba05d9cdf7876a15ecf58861d1c"`
不填写count参数则默认二十条,如果加上该参数:
`https://txc.qq.com/api/v1/1234/posts?max_id=153985337910779971&count=30 -H "Timestamp: 1539854769" -H "Signature: ad22dba05d9cdf7876a15ecf58861d1c"`
另外两个时间可选参数:from, to 字符串格式,形如:from=20180123&to=20180124 可以获取,2018年1月23日全日的数据 4.数据格式字典
{
"status": 0,
"message": null,
"pagination": {
"per_page": 5,
"next_page_url": "/api/v1/33588/posts?max_id=153985337910779973",
"from": "20180911",
"to": "20180912",
"total": 9,
},
"object": "post",
"data": [
{
"id": "153985339090723620", // id 值 大
"has_admin_reply": true,
"avatar_url": "https://txc.qq.com/static/desktop/img/products/def-product-logo.png",
"nick_name": "#゛~",
"content": "999999",
"openid": "tucao_123",
"user_id": 1,
"user": null,
"is_admin": true,
"is_top": false,
"is_good": false,
"is_spam": false,
"is_todo": false,
"is_locked": false,
"is_hidden": false,
"is_notice": false,
"is_liked": false,
"is_abuse": false,
"reply_count": 0,
"like_count": 0,
"images_count": 0,
"created_at": "2018-10-18 17:03:10",
"time": "21分钟前",
"updated_at": "2018-10-18 17:03:10",
"last_reply_at": "1970-01-01 00:00:00",
"images": [],
"replies": [],
"extra": [],
"faq_id": 0,
"replies_all": [],
"categories": [],
"field_values": []
},
//.....
{
"id": "153985337910779971", // id 值 小
"has_admin_reply": true,
"avatar_url": "https://txc.qq.com/static/desktop/img/products/def-product-logo.png",
"nick_name": "#゛~",
"content": "5555555",
"openid": "tucao_123",
"user_id": 1,
"user": null,
"is_admin": true,
"is_top": false,
"is_good": false,
"is_spam": false,
"is_todo": false,
"is_locked": false,
"is_hidden": false,
"is_notice": false,
"is_liked": false,
"is_abuse": false,
"reply_count": 0,
"like_count": 0,
"images_count": 0,
"created_at": "2018-10-18 17:02:59",
"time": "21分钟前",
"updated_at": "2018-10-18 17:02:59",
"last_reply_at": "1970-01-01 00:00:00",
"images": [],
"replies": [],
"extra": [],
"faq_id": 0,
"replies_all": [],
"categories": [],
"field_values": []
}
]
}
字段说明
目前支持的参数如下,如果以下参数仍不满足需求,可以在 customInfo 中自定义参数。
字段名 | 说明 |
---|---|
avatar_url | 发贴人头像 |
nick_name | 发贴人昵称 |
content | 发贴内容 |
openid | 发贴人 openid (业务自己传入的唯一 id) |
user_id | 发贴人 uid (兔小巢系统生成的唯一 id) |
is_admin | 发贴人是否为管理员 |
is_top | 是否置顶 |
is_spam | 是否为水贴 |
is_todo | 是否为待处理 |
is_locked | 是否已锁定 |
is_hidden | 是否已隐藏 |
is_notice | 是否为公告 |
is_abuse | 是否被举报过 |
reply_count | 回复数量 |
images_count | 主贴内容的数量 |
created_at | 发贴时间 |
updated_at | 贴子最后更新时间 |
last_reply_at | 最后回复时间 |
images | 图片附件 |
replies | 回复 |
categories | 问题分类 |
extra | 业务自定义的字段内容由 customInfo 字段传入 |
total | 翻页参数中的total,给定 from, to 参数时有值,为限定时间段内的反馈总数据量 |
5.安全限制
(1).每次最多只能拉100条。
(2).每分钟最多100次。
(3).为避免大量重复请求,兔小巢会对时间戳和签名进行校验,仅允许一定时间范围内的时间戳,建议每次请求更新时间戳和签名。