"api工厂" 使用手册

api接口开箱即用,云后台管理,助力前端,解放后端开发;

不懂编程也能独立开发应用,小步快跑,快速创业!

旨为更懂你!

数据推送服务介绍

数据推送服务,是指的“api工厂”的数据,推送到你指定的一个推送 URL 地址。


比如,有新订单产生的时候,我们会将订单的数据推送到你的 URL 地址,你就可以实时接收到数据,并且自己处理数据即可。


启用插件


  1. 如果你是免费会员户,有点小遗憾,暂时无法使用api工厂的插件功能;
  2. 如果你是专业版会员,那么登录后台,左侧菜单 “工厂设置” --> “插件管理” ,找到 “数据推送” 插件,在线购买开通即可;
  3. 如果你是增值版会员,那么无需做任何操作,你可以免费使用所有的插件功能;


推送频率


我们会以 POST 的方式将数据推送到你的 URL 地址,如果你成功接收到数据,并且处理成功以后,请返回 success 纯文本信息,我们收到你返回的 success 以后,认为你已经成功接收并处理,不需要重新推送本次数据,本次推送结束;反之,我们会认为你没有成功接收并处理本次推送数据,我们会进行重复推送,一共重试16次,16次推送完以后,及时你仍然未返回 success,我们也不再继续推送本次数据;这16次推送的频率如下:


  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小时后;


推送协议


假如你的接收推送数据的 URL 地址为:  https://www.yourdomain.com/receive


我们会将数据(一般为 json 数据格式)使用 POST 的形式,存放在 request.body 中,直接提交给这个 URL 地址


你本地可以使用 api调试工具自行先调试你的 URL 地址,可以接收到数据:


image.png


推送内容


用户注册


当有新的用户注册你的小程序,或者后台管理员手动添加用户,“api工厂”会将用户信息推送给您,便于您和现有的用户体系打通


推送示例数据:


{
    "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
}


删除用户


当你在“api工厂”后台,或者使用 “api工厂”的删除用户接口,删除了某个用户,我们将会将本次删除的用户信息推送给你


推送的数据示例:


{
  type: "directSendOriginalData",
  mod: "user",
  action: "delete",
  userId : 10,
  uid: 1234
}


uid 为具体删除的那个用户的用户编号,mod、type、action、userId 字段固定不变,可以不用理会


订单信息


当有新的订单产生、订单状态发生变化(关闭、支付、发货、收货、评价)的时候,我们都会将最新的订单信息推送给你,具体的推送数据,您可以查看订单详情接口,推送数据内容和订单详情接口的返回值保持一致。


支付成功


通过“api工厂”的在线支付功能,支付成功以后,我们也会将支付信息,推送给你。


更多推送


如果你有更多的推送需求,请联系我们,我们尽快为你接入!

Copyright © 杭州于芯科技有限公司

浙ICP备15041833号