帮助支持

用清晰的接口边界,保障系统稳定扩展。

这是一个“API 文档落地页模板”。如果你有真实 API 文档地址,可以把此页改成跳转外部文档或嵌入 iframe。 当前内容基于项目模块能力抽象出常见接口类型,便于对外说明与内部对齐口径。

接口类型(与项目能力对应)

  1. 店铺类:店铺列表、同步、授权、基础配置保存。
  2. 商品类:listing 查询、批量上/下架、删除、送审、批量改价改库存、日志查询。
  3. 仓库类:仓库映射列表、手动同步、映射保存。
  4. 健康与评价:风险选项、健康数据、提醒记录、评价列表与导出。
文档建议包含
鉴权方式、字段口径、分页规则、错误码与重试策略、异步任务的查询与回调约定。

最佳实践

  1. 批量接口建议支持幂等(避免重复提交导致的状态错乱)。
  2. 异步任务建议返回任务ID,并提供查询接口或消息通知机制。
  3. 日志接口要能按时间与业务对象(listing/shop)快速定位。