跳至主要内容
Grow 方案

您的订单, 进入您自己的工具。

有了 Grow,您可以创建只读 API 密钥,把订单、商品和库存拉进您自己的报表,并在订单付款、发货、送达、取消或退款时,向您的服务器发送带签名的订单事件。

获取 Grow
5
个有效的只读 API 密钥
60 / 分钟
每个密钥允许的请求数
5 种事件
已付款、已发货、已送达、已取消和已退款
30 天
成功投递记录保留在投递日志中

01 — API 密钥

用密钥 读取您的数据。

在设置 → 集成中最多创建五个只读密钥。勾选每个密钥的访问范围:订单、商品或库存。密钥只显示一次,请当时就复制;如果丢失,请撤销它并创建新的。用该密钥作为 Bearer 令牌调用 GET /api/v1/orders、/api/v1/products 或 /api/v1/inventory。响应为 JSON,默认每页 50 条(最多 100 条),并带有下一页的游标,每个密钥每分钟可发出 60 个请求。撤销密钥或 Grow 结束都会停止访问。

  • 最多 5 个有效密钥,各有自己的访问范围
  • 仅 GET:订单、商品、库存
  • 每页 50 条,最多 100 条;每分钟 60 个请求
只读 API 密钥
密钥名称报表 · jjk_Ab3dE9fG…
orders:readproducts:readinventory:read
GET /api/v1/orders?limit=50Authorization: Bearer jjk_…{ "data": [ … ], "nextCursor": "…" }

请立即复制此密钥。它不会再次显示。

示例数据,仅供说明

02 — Webhook

订单变化时 收到通知。

在设置 → 集成 → 订单 Webhook 中添加 HTTPS 端点并选择事件:order.paid、order.shipped、order.delivered、order.cancelled 和 order.refunded。每次投递是一个 JSON 载荷,包含事件、唯一的事件键、发生时间和订单快照:商品、以仙计的金额、状态、买家和收货详情。请先发送测试。投递会先排队,每隔几分钟发送一次,所以预计在订单变化后的几分钟内送达。

  • 五种订单事件
  • 仅支持 HTTPS 端点
  • 正式依赖前先发送测试事件
订单 Webhookhttps://example.com/hooks/jomjual
order.paidorder.shippedorder.deliveredorder.cancelledorder.refunded
{ "event": "order.paid", "event_key": "…", "occurred_at": "…", "order": { … } }

投递会排队,每隔几分钟发送一次。

示例数据,仅供说明

03 — 验证

确认每个请求 确实来自我们。

每个请求都带有 X-JomJual-Signature 标头:一个时间戳,以及用您端点的签名密钥对“时间戳、一个点、原始请求正文”计算的 HMAC-SHA256 签名(签名密钥只在创建端点时显示一次)。请在您这边重新计算,用恒定时间比较,并拒绝早于五分钟的时间戳。X-JomJual-Event-Id 是每个事件的唯一键。投递保证至少一次,所以请用它忽略重复。请在十秒内返回任意 2xx 响应。

  • 用您的签名密钥计算 HMAC-SHA256
  • 拒绝早于五分钟的时间戳
  • 根据 X-JomJual-Event-Id 去重
您的接收端要检查什么X-JomJual-Signature: t=1760000000,v1=9f2c…
  • 重新计算 HMAC时间戳、一个点,再加原始正文,使用您的密钥1
  • 用恒定时间比较不匹配就拒绝该请求2
  • 检查时间戳拒绝任何早于五分钟的请求3
  • 跳过重复根据 X-JomJual-Event-Id 去重4

示例数据,仅供说明

04 — 重试

重试、重新发送 和日志。

如果您的端点没有在十秒内返回 2xx,JomJual 会在 1 分钟、5 分钟、30 分钟、2 小时和 6 小时后重试,之后每天一次。它不会关闭您的端点。投递日志会显示每次投递的状态、尝试次数和响应,点击“重新发送”可再次发送。成功的投递最多保留 30 天,每个端点最多 1,000 条。

  • 按 1 分钟、5 分钟、30 分钟、2 小时、6 小时重试,之后每天一次
  • 可在日志中重新发送任意投递
  • 端点不会因为失败而被关闭
最近的投递
  • order.paid1 次尝试 · 200已送达
  • order.shipped2 次尝试 · 503待处理
  • order.delivered1 次尝试 · 200已送达

“重新发送”会再次发送任意投递。

示例数据,仅供说明

卖家为何转用

之前

复制粘贴订单

  • 手动导出订单
  • 到后台查看有没有新订单
  • 把订单详情重新输入到其他工具

使用 JomJual

订单直达您的工具

  • 用于报表的只读 API
  • 订单变化时发送带签名的 Webhook
  • 重试和投递日志

卖家 常问的问题。

这包含在 Grow 里吗?

是的。API 密钥和订单 Webhook 属于 Grow。如果 Grow 结束,API 访问会停止。

API 能修改任何东西吗?

不能。密钥是只读的,API 只响应 GET 请求。

Webhook 多久送达?

投递会排队,每隔几分钟发送一次,所以预计在订单变化后的几分钟内送达。

如果我的服务器宕机了怎么办?

JomJual 会在 1 分钟、5 分钟、30 分钟、2 小时和 6 小时后重试,之后每天一次,并且不会关闭您的端点。您也可以在日志中重新发送任意投递。

我会收到两次相同的事件吗?

有可能,投递保证至少一次。每个事件在 X-JomJual-Event-Id 和 event_key 中都有唯一键,所以请忽略您已经处理过的键。

谁可以设置?

店主,在设置 → 集成中。

Grow 方案的一部分。 预付费用,绝不自动续费。

查看 Grow 包含的内容