lingyun/OpenDoc
lingyun/OpenDoc
3
0
Code Issues Packages Projects Wiki

更新 RedBook_Home

tk 2024-07-31 18:54:39 +08:00
parent 48c6b8e9d8
commit 83cdca8ee1
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
RedBook_Home.md

@ -5,24 +5,24 @@
## 商家 API 接口 根地址 ## 商家 API 接口 根地址
正式环境：<a href="http://sdk.or.xhs92.com" target="_blank">http://sdk.or.xhs92.com</a> 正式环境：<a href="https://sdk.xhs92.top" target="_blank">https://sdk.xhs92.top</a>
测试环境：<a href="http://test-sdk.or.xhs92.com" target="_blank">http://test-sdk.or.xhs92.com</a> 测试环境：<a href="https://test-sdk.xhs92.top" target="_blank">https://test-sdk.xhs92.top</a>
## 阅读 API 功能文档 ## 阅读 API 功能文档
<a href="http://test-sdk.or.xhs92.com" target="_blank">http://test-sdk.or.xhs92.com</a> <a href="https://test-sdk.xhs92.top" target="_blank">https://test-sdk.xhs92.top</a>
## 商家身份鉴权 ## 商家身份鉴权
几乎所有的 API 都要求验证权限，目前只需要简单地在 HTTP 请求头中添加您的商家 Token 即可： 几乎所有的 API 都要求验证权限，目前只需要简单地在 HTTP 请求头中添加您的商家 Token 即可：
- Header Key：Merchant-Token - Header Key：Merchant-Token
- Header Value：XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX （<a href="http://admin.or.xhs92.com/#/profile/merchant" target="_blank">查看商家 Token</a>） - Header Value：XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX （<a href="https://admin.xhs92.top/#/profile/merchant" target="_blank">查看商家 Token</a>）
## 获取机器人帐号列表 ## 获取机器人帐号列表
您可以定期调用此接口，将划分给您的机器人账号同步到您自己的数据库：<a href="http://test-sdk.or.xhs92.com/index.html#/商家主机服务/management/api-sdk-management-get.robots-Post" target="_blank">查看接口文档</a> 您可以定期调用此接口，将划分给您的机器人账号同步到您自己的数据库：<a href="https://test-sdk.xhs92.top/index.html#/商家主机服务/management/api-sdk-management-get.robots-Post" target="_blank">查看接口文档</a>
此接口参数较多，如无特殊需求，只需要传递以下简要参数即可： 此接口参数较多，如无特殊需求，只需要传递以下简要参数即可：
``` json ``` json
@ -41,7 +41,7 @@
"pageSize": 100, "pageSize": 100,
"rows": [ "rows": [
{ {
"avatarUrl": "https://sns-avatar-qc.xhscdn.com/avatar/61d6617400000000100042b5.jpg?imageView2/2/w/360/format/webp", "avatarUrl": "https://sns-avatar-qc.xhscdn.top/avatar/61d6617400000000100042b5.jpg?imageView2/2/w/360/format/webp",
"captchaStatus": 1, "captchaStatus": 1,
"countryCode": 86, "countryCode": 86,
"createdTime": "2024-01-29 14:01:40", "createdTime": "2024-01-29 14:01:40",
@ -71,7 +71,7 @@
| Request Method | Request Url | Request Header | Request Body | | Request Method | Request Url | Request Header | Request Body |
|-|-|-|-| |-|-|-|-|
| POST | <a href="http://admin.or.xhs92.com/#/profile/merchant" target="_blank">设置用于接收异步任务结果的 URL 地址</a> | Merchant-Token: 您的商家Token <br />Content-Type: application/json | <a target="_blank" href="http://test-sdk.or.xhs92.com/"> 参见 API 文档的响应示例章节 </a> | | POST | <a href="https://admin.xhs92.top/#/profile/merchant" target="_blank">设置用于接收异步任务结果的 URL 地址</a> | Merchant-Token: 您的商家Token <br />Content-Type: application/json | <a target="_blank" href="https://test-sdk.xhs92.top/"> 参见 API 文档的响应示例章节 </a> |
### 超时约定 ### 超时约定
@ -89,15 +89,15 @@
| Request Method | Request Url | Request Header | Request Body | | Request Method | Request Url | Request Header | Request Body |
|-|-|-|-| |-|-|-|-|
| POST | <a href="http://admin.or.xhs92.com/#/profile/merchant" target="_blank">设置用于接收变更事件推送的 URL 地址</a> | Merchant-Token: 您的商家Token <br />Content-Type: application/json | { type: <a target="_blank" href="http://test-api.or.xhs92.com/index.html#/SwaggerModels/资源组件"> PushTypes </a>, data: 推送数据 } | | POST | <a href="https://admin.xhs92.top/#/profile/merchant" target="_blank">设置用于接收变更事件推送的 URL 地址</a> | Merchant-Token: 您的商家Token <br />Content-Type: application/json | { type: <a target="_blank" href="https://test-api.xhs92.top/index.html#/SwaggerModels/资源组件"> PushTypes </a>, data: 推送数据 } |
### 推送事件 ### 推送事件
| 事件类型 | 类型描述 | 推送数据 | | 事件类型 | 类型描述 | 推送数据 |
|-|-|-| |-|-|-|
| robotOnlineStatusChange | 机器人在线状态变更 | <a target="_blank" href="http://test-api.or.xhs92.com/index.html#/SwaggerModels/资源组件">QueryRobotRsp</a> | | robotOnlineStatusChange | 机器人在线状态变更 | <a target="_blank" href="https://test-api.xhs92.top/index.html#/SwaggerModels/资源组件">QueryRobotRsp</a> |
| robotCaptchaStatusChange | 机器人人机验证状态变更 | <a target="_blank" href="http://test-api.or.xhs92.com/index.html#/SwaggerModels/资源组件">QueryRobotRsp</a> | | robotCaptchaStatusChange | 机器人人机验证状态变更 | <a target="_blank" href="https://test-api.xhs92.top/index.html#/SwaggerModels/资源组件">QueryRobotRsp</a> |
| robotForbiddenStatusChange | 机器人封号状态变更 | <a target="_blank" href="http://test-api.or.xhs92.com/index.html#/SwaggerModels/资源组件">QueryRobotRsp</a> | | robotForbiddenStatusChange | 机器人封号状态变更 | <a target="_blank" href="https://test-api.xhs92.top/index.html#/SwaggerModels/资源组件">QueryRobotRsp</a> |
## 流量风控 ## 流量风控