此页面由英文翻译而成。英文版为官方权威来源。如翻译内容有任何不一致之处,请以英文版为准。
环境
Flex Forward API 提供两个环境,分别用于生产运营和开发测试。可用环境
所有请求必须使用 HTTPS。通过 HTTP 发送的请求将被拒绝。
开发环境
开发环境连接至物流商的沙盒服务(如 YunExpress 沙盒)。适用于:- 在不创建实际配送的情况下测试您的集成
- 验证请求格式和响应处理
- 开发错误处理和重试逻辑
沙盒物流商服务可能返回模拟的追踪数据和标签文件。响应时间和可用的追踪状态可能与生产环境不同。
沙盒测试数据
开发环境支持生成可预测追踪响应的测试值。使用这些来验证您的集成能正确处理不同的配送结果:测试值和模拟响应可能会变更。如需最新的沙盒测试数据,请联系 Flex Forward 团队。
认证信息分离
每个环境请使用单独的 API 令牌。请勿在开发环境中使用生产认证信息,反之亦然。两组认证信息都由您在用户门户自行创建与管理;Flex Forward 不会颁发或轮换它们。认证信息最佳实践
- 将令牌存放在环境变量或密钥管理器中
- 切勿在源代码中硬编码令牌或将其提交至版本控制
- 每个环境使用单独令牌,以防止开发期间意外发送生产请求
- 当您自己的安全策略需要时,在用户门户重新生成认证信息;Flex Forward 不会代您轮换或使其过期
速率限制
目前未强制实施速率限制。建议每个账户将请求量控制在 每秒 10 个请求 以下。速率限制头部(X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset)目前不包含在响应中。
所有端点均已声明带有 Retry-After 头部(需等待的秒数)的 HTTP 429 Too Many Requests 响应。请现在就实现相应处理,以便集成在限制正式启用后不受影响:收到 429 时,暂停 Retry-After 秒后重试同一请求。请参阅错误处理。
如果未来引入速率限制,将通过变更记录提前通知。如需针对高吞吐量集成讨论容量规划,请联系 Flex Forward 团队 [email protected]。
上线检查清单
从开发环境切换至生产环境前:- 建议:请先在沙盒环境中测试您的集成,开发用认证信息可从 User Portal 获取
- 生产 API 密钥与令牌已从 User Portal(Settings → Signing Key and API Token)获取
- 配送账户已配置生产物流商
- 在开发环境中标签创建测试成功
- 标签文件获取已测试
- 追踪获取已测试
- 幂等性行为已验证(相同密钥与请求体会重放结果;请求体更改则返回
IDEMPOTENCY_CONFLICT) - 已实现所有状态码的错误处理
- 所需物流商和物流路线配置已确认