Browse all articles

ChannelDock REST API 文档

Last updated

ChannelDock REST API 允许您将自有软件连接到 ChannelDock，并处理订单、产品、发货、退货和库存更新。

完整的端点列表、身份验证详情、请求示例和响应示例见 API 文档：

https://docs.channeldock.com

REST API 可以做什么？

  • 检索订单和订单更新

  • 读取产品和库存信息

  • 根据端点创建或更新发货

  • 在 ChannelDock 与您的 ERP、WMS 或网店之间构建自定义集成

快速开始

  1. 登录 ChannelDock，前往 Settings → API & Webhooks。

  2. 在 API keys 部分，点击 Generate new API keys。

  3. 为凭据填写清晰描述，以便日后识别该集成。

  4. 将 API key 和 API secret 保存在安全位置。

  5. 打开 API 文档，在开始开发前查看可用端点、必填参数和示例载荷。

身份验证与安全

每个 API 请求都必须使用您的 API 凭据进行身份验证。请对 API key 和 API secret 保密，切勿在前端代码或公开仓库中暴露。

建议为每个集成创建单独的 API 密钥并限制端点权限，以便管理访问并在需要时轮换凭据。

速率限制

ChannelDock REST API 按 API 密钥实施速率限制。默认情况下，一个 API 密钥每小时最多 1000 次请求。

每个 API 响应包含以下速率限制标头：

  • X-RateLimit-Limit

  • X-RateLimit-Remaining

  • X-RateLimit-Reset

超出限制时，API 返回 HTTP 429 响应，消息为：

API call limit exceeded. Please try again later.

建议在集成中监控 X-RateLimit-Remaining 和 X-RateLimit-Reset 标头，以便在触及限制前放慢请求。

最佳实践

  • 先在开发环境中测试请求，再用于生产。

  • 将端点权限限制为集成所需的方法。

  • 如果需要近实时更新，请使用 webhook，而不是持续轮询 API。

Was this helpful?

Related articles