当使用小红书笔记详情API时,为了获取并理解其返回值,以下是一个实用的指南:
1. API请求概述
- 请求方式:HTTP GET(或其他支持的请求方式,如POST)
- 请求地址:根据API文档提供的URL,如
https://api-gw-4.cn/smallredbook/item_get_video
2. 请求参数
- 必要参数:
num_iid
(笔记ID),这是唯一标识小红书笔记的参数。 - 其他参数:可能还包括API密钥(
key
)和API密钥的秘密(secret
),用于身份验证和访问控制。
item_get_video-获得小红书笔记详情
smallredbook.item_get_video
公共参数
请求地址:
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
key | String | 是 | 调用key(必须以GET方式拼接在URL中) |
secret | String | 是 | 调用密钥 |
api_name | String | 是 | API接口名称(包括在请求地址中)[item_search,item_get,item_search_shop等] |
cache | String | 否 | [yes,no]默认yes,将调用缓存的数据,速度比较快 |
result_type | String | 否 | [json,jsonu,xml,serialize,var_export]返回数据格式,默认为json,jsonu输出的内容中文可以直接阅读 |
lang | String | 否 | [cn,en,ru]翻译语言,默认cn简体中文 |
version | String | 否 | API版本 |
请求参数
请求参数:num_iid=649c46ab000000002702ad36
参数说明:num_iid:笔记ID
响应参数
Version: Date:
名称 | 类型 | 必须 | 示例值 | 描述 |
---|---|---|---|---|
item |
item[] | 0 | 获取小红书用户作品 |
3. 请求示例
使用curl命令或其他HTTP客户端工具发送请求。示例(已对URL参数进行编码处理):
curl -i "https://api-gw-4.cn/smallredbook/item_get_video/?key=<您的API密钥>&secret=<您的API密钥秘密>&num_iid=649c46ab000000002702ad36"
4. 返回值解析
返回值通常以JSON格式呈现,包含以下字段(注意:不同版本的API可能返回不同的字段集):
- id/num_iid:笔记的唯一标识符。
- detail_url:笔记的详细链接(例如,
https://www.xiaohongshu.com/explore/649c46ab000000002702ad36
)。 - title:笔记的标题。
- content(可能包含):笔记的详细内容,可以是文本、HTML或其他富文本格式。
- images(可能包含):一个包含笔记中图片URL的数组。
- user/nick/uid:包含笔记作者的详细信息,如昵称和唯一标识符。
- created_at/updated_at:分别表示笔记的创建时间和最后更新时间。
- likes_count/comments_count:分别表示这篇笔记的点赞数和评论数(如果API返回这些字段)。
- tags:一个包含笔记标签的数组。
- location:如果笔记包含了地理位置信息,这里会包含相关信息。
- views_count:表示这篇笔记的浏览量(注意:并非所有版本的API都会返回这个字段)。
数据示例
"item": {
"num_iid": "649c46ab000000002702ad36",
"detail_url": "https://www.xiaohongshu.com/explore/649c46ab000000002702ad36",
"title": "变形金刚4",
"type": "video",
"video": "http://sns-video-qc.xhscdn.com/stream/110/258/01e49c46a63bcd390103770389027d1ad7_258.mp4?sign=180a24669a446bf75a3ec79f41926bcb&t=64a04c54",
"pic_url": "https://sns-img-hw.xhscdn.com/0ccd59b9-71ad-d2c0-ec5a-afac90d21355?imageView2/2/h/1920/format/webp|imageMogr2/strip",
"tag_list": [
{
"name": "变形金刚",
"type": "topic",
"id": "545c2716d6e4a924bf74ed49"
}
],
"desc": " 这就是柱子哥的魅力",
"city": "河北",
"nick": "变形金刚电影剪辑",
"uid": "64805fc1000000000f004891",
"interact_info": {
"liked_count": "41",
"collected_count": "16",
"comment_count": "0"
},
"time": "2023-06-28 22:41:47",
"_ddf": "mt"
},
"error": "",
"reason": "",
"error_code": "0000",
"cache": 0,
"api_info": "today:182 max:10100 all[5611=182+44+5385];expires:2030-12-31",
"execution_time": "1.957",
"server_time": "Beijing/2023-06-30 17:21:49",
"client_ip": "106.6.34.137",
"call_args": [],
"api_type": "smallredbook",
"translate_language": "zh-CN",
"translate_engine": "baidu",
"server_memory": "3.03MB",
"request_id": "1.649e9eab4b441",
"last_id": "1840805874"
}
异常示例
复制
{
错误码解释
状态代码(error_code) | 状态信息 | 详细描述 | 是否收费 |
---|---|---|---|
0000 | success | 接口调用成功并返回相关数据 | 是 |
2000 | Search success but no result | 接口访问成功,但是搜索没有结果 | 是 |
4000 | Server internal error | 服务器内部错误 | 否 |
4001 | Network error | 网络错误 | 否 |
4002 | Target server error | 目标服务器错误 | 否 |
4003 | Param error | 用户输入参数错误 | 忽略 |
4004 | Account not found | 用户帐号不存在 | 忽略 |
4005 | Invalid authentication credentials | 授权失败 | 忽略 |
4006 | API stopped | 您的当前API已停用 | 忽略 |
4007 | Account stopped | 您的账户已停用 | 忽略 |
4008 | API rate limit exceeded | 并发已达上限 | 忽略 |
4009 | API maintenance | API维护中 | 忽略 |
4010 | API not found with these values | API不存在 | 忽略 |
4012 | Please add api first | 请先添加api | 忽略 |
4013 | Number of calls exceeded | 调用次数超限 | 忽略 |
4014 | Missing url param | 参数缺失 | 忽略 |
4015 | Wrong pageToken | 参数pageToken有误 | 忽略 |
4016 | Insufficient balance | 余额不足 | 忽略 |
4017 | timeout error | 请求超时 | 否 |
5000 | unknown error | 未知错误 | 否 |