数据推送服务介绍:让 api工厂 的数据实时到达你的服务器
帮助文档
随时更新
**数据推送服务**,是指"api工厂"把你的数据,主动推送到你指定的一个 **推送 URL 地址**。
举个例子:有新订单产生时,我们会立刻把订单数据推送到你的 URL,你的系统**实时接收、自行处理**即可——不用轮询、不用定时拉取。
## 推送机制一览
> api工厂 以 **POST** 方式将数据(一般为 JSON)放入 `request.body`,提交到你的 URL → 你接收并处理成功后返回纯文本 `success` → 本次推送结束;未返回 `success` 则按递增间隔**自动重试**。
>
## 第一步:启用「数据推送」插件
| 会员类型 | 能否使用 | 需要做什么 |
| --- | --- | --- |
| 免费会员 | ❌ 暂不支持 | 需升级会员后才能使用插件功能 |
| 专业版会员 | ✅ 支持 | 登录后台 → 左侧菜单「工厂设置」→「插件管理」→ 找到「数据推送」插件 → 在线购买开通 |
| 增值版会员 | ✅ 支持 | 无需任何操作,所有插件免费使用 |
## 推送协议:你的接收端要做什么?

假设你的接收 URL 为:
```plain
https://www.yourdomain.com/receive
```
我们会将数据(一般为 JSON 格式)使用 **POST** 方式,存放在 `request.body` 中,直接提交给这个地址。你的接收端只需做两件事:
1. **接收并处理** `request.body` 中的数据;
2. 处理成功后,**返回纯文本 **`success`。
> 💡 上线前,可以先在本地用 API 调试工具向你的 URL 发起 POST 请求,验证能否正常接收数据。
>
> 📷 配图建议:API 调试工具模拟推送的截图
>
## 重试机制:没返回 success 会怎样?
+ 我们收到你返回的 `success`,即认为本次推送**成功接收并处理**,不再重推,本次推送结束;
+ 反之,我们认为本次推送未成功,会**自动重复推送,一共重试 16 次**;
+ 16 次推送完成后,即使你仍未返回 `success`,也**不再继续推送**本次数据。
重试间隔如下(均相对前一次推送):
| 重试次序 | 距前一次推送的间隔 |
| --- | --- |
| 第 1 次 | 3 秒后 |
| 第 2 次 | 5 秒后 |
| 第 3 次 | 15 秒后 |
| 第 4 次 | 30 秒后 |
| 第 5 次 | 1 分钟后 |
| 第 6 次 | 5 分钟后 |
| 第 7 次 | 10 分钟后 |
| 第 8 次 | 20 分钟后 |
| 第 9 次 | 30 分钟后 |
| 第 10 次 | 45 分钟后 |
| 第 11 次 | 1 小时后 |
| 第 12 次 | 2 小时后 |
| 第 13 次 | 3 小时后 |
| 第 14 次 | 4 小时后 |
| 第 15 次 | 5 小时后 |
> ⚠️ 请确保你的接收端**处理成功才返回 **`success`,并做好幂等处理(同一条数据可能因重试被推送多次)。
>
## 推送内容:哪些数据会推给你?
### 1. 用户注册
当有新用户注册你的小程序,或后台管理员手动添加用户时,我们会将用户信息推送给你,便于你和现有用户体系打通。
推送示例数据:
```json
{
"mod": "user",
"uid": 1751316,
"data": {
"id": 1751316,
"pwd": "fbff7f21cd71d4bc2b7569918a8917d5",
"salt": "wZm094",
"ipAdd": "127.0.0.1",
"source": 4,
"userId": 2,
"username": "aaaa1",
"sourceStr": "用户名注册",
"cardNumber": "201112185320002"
},
"action": "add",
"userId": 2
}
```
### 2. 删除用户
当你在"api工厂"后台、或通过删除用户接口删除了某个用户时,我们会将被删除的用户信息推送给你。
推送示例数据:
```json
{
"type": "directSendOriginalData",
"mod": "user",
"action": "delete",
"userId": 10,
"uid": 1234
}
```
字段说明:`uid`** 为被删除用户的用户编号**;`mod`、`type`、`action`、`userId` 字段固定不变,可以不用理会。
### 3. 订单信息
以下时机都会推送**最新的订单信息**:
+ 新订单产生;
+ 订单状态发生变化:**关闭、支付、发货、收货、评价**。
推送数据内容与**订单详情接口的返回值保持一致**,字段说明可直接查看订单详情接口文档。
### 4. 支付成功
通过"api工厂"的在线支付功能完成支付后,我们也会将支付信息推送给你。
## 更多推送需求
如果你有其他数据推送需求,**请联系我们**,我们会尽快为你接入!
## 小结
> 开通插件 → 准备一个接收 URL → POST 收 JSON、处理成功回 `success`;用户注册/删除、订单全生命周期、支付成功都会实时推送,失败自动重试 16 次。
>