From e64ead9d316947b184af2c116b2967fbabebbd83 Mon Sep 17 00:00:00 2001 From: tk Date: Tue, 28 May 2024 09:50:12 +0800 Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=20RedBook=5FHome?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- RedBook_Home.md | 116 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 116 insertions(+) create mode 100644 RedBook_Home.md diff --git a/RedBook_Home.md b/RedBook_Home.md new file mode 100644 index 0000000..53a98a5 --- /dev/null +++ b/RedBook_Home.md @@ -0,0 +1,116 @@ +
+

小红书开放平台 - 商家接入文档

+
+ + +## 商家 API 接口 根地址 + +正式环境：http://sdk.or.xhs92.com + +测试环境：http://test.sdk.or.xhs92.com + +## 阅读 API 功能文档 + +http://test.sdk.or.xhs92.com + +## 商家身份鉴权 + +几乎所有的 API 都要求验证权限，目前只需要简单地在 HTTP 请求头中添加您的商家 Token 即可： + +- Header Key：Merchant-Token +- Header Value：XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX （查看商家 Token） + +## 获取机器人帐号列表 + +您可以定期调用此接口，将划分给您的机器人账号同步到您自己的数据库：查看接口文档 + +此接口参数较多，如无特殊需求，只需要传递以下简要参数即可： +``` json +{ + "page": 1, // 页码 + "pageSize": 100 // 页容量 +} +``` + +响应示例： +``` json +{ + "code": 0, + "data": { + "page": 1, + "pageSize": 100, + "rows": [ + { + "avatarUrl": "https://sns-avatar-qc.xhscdn.com/avatar/61d6617400000000100042b5.jpg?imageView2/2/w/360/format/webp", + "captchaStatus": 1, + "countryCode": 86, + "createdTime": "2024-01-29 14:01:40", + "deviceId": "172019088018051", + "enabled": true, + "id": "044056dc-355c-353c-49bc-d05dc081bf38", //此参数为机器人帐号标识，绝大部分API调用都需要传递此参数 + "modifiedTime": "2024-02-04 15:07:57", + "nickName": "开心快乐每一天", + "onlineStatus": 1, + "ownerId": 508249334046725, + "pushType": 0, + "redbookVersion": "8.4.0" + } + ], + "total": 469 + } +} +``` + +## 任务回调 + +接口文档中，未标记为“同步”的接口，默认是异步模式；调用完毕当即只会响应一个 TaskId（任务编号）。 + +而具体的结果，后续会在任务执行完毕后，通过 HTTP 请求回传到您的 Web 服务器。 + +### 回调协议 + +| Request Method | Request Url | Request Header | Request Body | +|-|-|-|-| +| POST | 设置用于接收异步任务结果的 URL 地址 | Merchant-Token: 您的商家Token
Content-Type: application/json | 参见 API 文档的响应示例章节 | + +### 超时约定 + +系统约定异步任务执行的超时时间为 **7200秒**，超过此时间任务状态会变更为“完成超时”，为任务终态。 + +超时任务不再回调任务信息，调用方须在发起任务7200秒后，自行做好超时处理。 + +## 主动推送 + +当与您相关的重要的信息发生了变化，会主动通知到您，以便您对自己的系统做好相应的处理。 + +通知方式也是通过 HTTP 请求传递到您的 Web 服务器。 + +### 推送协议 + +| Request Method | Request Url | Request Header | Request Body | +|-|-|-|-| +| POST | 设置用于接收变更事件推送的 URL 地址 | Merchant-Token: 您的商家Token
Content-Type: application/json | { type: PushTypes , data: 推送数据 } | + +### 推送事件 + +| 事件类型 | 类型描述 | 推送数据 | +|-|-|-| +| robotOnlineStatusChange | 机器人在线状态变更 | QueryRobotRsp | +| robotCaptchaStatusChange | 机器人人机验证状态变更 | QueryRobotRsp | +| robotForbiddenStatusChange | 机器人封号状态变更 | QueryRobotRsp | + +## 流量风控 + +为了保护账号资源，本系统目前实施的防火墙规则如下： +1. 账号登录接口，相同账号频率5分钟/次，50次/天。 +2. 其它功能接口，同账号同功能1分钟/次，100次/天。 +3. 同账号，所有接口共200次/天。 + +当您调用接口的频次超过以上任意规则，会创建任务失败，并当即响应错误信息，响应示例： +``` json +{ + "code": 9400, + "msg": "流量超限 RateLimitConfigInfo { Frequency = 1, TimeWindow = 60, Type = Solo }" +} +``` +此示例表示当前接口调用触发了机器人同一接口每分钟调用不得超过1次的限制。 \ No newline at end of file