API 集成

API 集成是指两个或多个软件系统通过应用程序编程接口(API)相连,从而自动交换数据并触发操作。一个系统发送结构化请求,另一个系统返回数据或确认变更,无需手动导出和导入。

系统之间的约定

API 是一套公开发布的、与某个软件进行通信的规则。它规定了允许哪些请求、每个请求必须包含哪些信息,以及回复是什么样子。由于双方遵循同一约定,即使它们由不同公司用不同编程语言构建,也能协同工作。

集成是在这一约定之上建立的实际连接。它决定传输哪些数据、往哪个方向、多久一次,以及出现故障时如何处理。

请求、响应与事件

  • 读取请求用于获取数据,例如某个商品当前的价格和库存。
  • 写入请求用于修改数据,例如为某个商品设置新价格。
  • 响应返回结果,通常采用 JSON 等结构化文本格式,并带有表示成功或失败的状态码。
  • webhook 把流程反过来:事件一发生(例如有新订单),一个系统就立即通知另一个系统,而不是等待对方询问。

大多数 API 需要身份验证,通常是一个密钥或令牌,用于识别调用方并限制其可执行的操作。密钥应安全保存,并且只授予集成所需的权限。

API 在电商中的应用

现代店铺依靠多个相互连接的工具运转。典型配置可能把店铺平台与支付服务商、物流服务、记账软件、电商平台渠道、邮件工具和定价工具连接起来。每一个连接都是一个集成,它们共同让业务运转,而无需不停地手动录入数据。

价格是在这些连接中传输的最敏感的数值之一。在某处设定的价格,可能需要同步到网店、电商平台商品页以及购物广告的商品数据源。如果其中一个副本更新滞后,顾客就会在不同地方看到不同价格,而广告平台也可能拒绝数据源价格与落地页不一致的商品。

价格更新流程示例

举例来说,设想一家相机配件店每天早上复核价格。07:00,定价工具为 120 款商品计算出新价格。它通过店铺平台的 API 发送写入请求,每个商品一个请求,或在 API 允许时批量发送。店铺对 118 款商品返回成功代码,对 2 款已不存在的商品返回错误。工具记录这些错误,由一名员工把旧商品从价格清单中移除。

如果没有集成,就得有人手动复制 120 个价格,既慢又很可能出现输入错误。有了集成,几分钟就能完成,并且每次变更都有记录。BlackAha 的 店铺集成 正是通过这种连接,把价格同步到已连接的店铺。

在 API、数据源和手动文件之间做选择

API 并不是传输数据的唯一方式。商品数据源是按计划发布的文件,适合每天变化几次的大型商品目录。电子表格导入仍适用于一次性迁移。当变更必须快速、有选择性或需要确认时,例如在几分钟内更新单个价格并确认成功,API 是更好的选择。

可能出现的问题

  • 频率限制:平台会限制调用方每分钟可发送的请求数,因此批量更新必须控制节奏。
  • 版本变更:服务商会停用旧版 API,集成必须及时更新。
  • 字段不匹配:如果字段配对错误,一个系统的促销价可能被映射为另一个系统的原价。
  • 部分失败:有些请求成功、有些失败,导致数据只更新了一半。
  • 静默错误:集成停止运行却没有提醒任何人,可能让过时的价格在线上挂好几天。

有两项保障措施能覆盖大部分问题。第一,记录每个请求和响应,以便追查问题。第二,监控结果,例如每次更新后抽查一部分线上价格是否与预期一致。

规划可靠的集成

  1. 为每个字段(如价格、库存或商品标题)确定哪个系统是唯一可信来源。
  2. 仔细映射字段,包括币种、税费设置和变体标识符。
  3. 在启用整个商品目录之前,先在测试店铺或少量商品上测试。
  4. 设置限制,例如每次更新的最大价格变动,防止错误输入扩散。
  5. 指定一名负责人接收错误提醒并检查日志。

明确的负责人和代码同样重要。当搭建集成的人离职时,一份简短的书面说明,写明它做什么、使用哪些密钥、日志存放在哪里,能为接手的人省去大量猜测。

要点总结

  • API 集成通过明确定义的接口连接系统,让它们自动交换数据。
  • 在电商中,集成让价格、库存、商品和订单在店铺与工具之间流转。
  • webhook 即时推送事件,而 API 请求按需拉取或推送数据。
  • 频率限制、字段不匹配和静默故障是最常见的问题。
  • 为每个字段指定唯一可信来源,先在小范围内测试,并监控每次更新。

常见问题

API 是什么的缩写?

API 是应用程序编程接口(application programming interface)的缩写。它是一套明确的方式,让一个软件向另一个软件请求数据或操作。

设置 API 集成需要开发人员吗?

不一定。许多工具提供现成的连接器,您只需登录或粘贴密钥并选择设置即可。没有现成连接器的系统之间做定制集成,通常需要开发工作。

API 和 webhook 有什么区别?

通过 API 调用,一个系统在需要时向另一个系统请求数据或发送变更。通过 webhook,当事件发生时,另一个系统会自动发送通知。许多集成两者都会使用。

API 集成安全吗?

只要密钥保密、权限仅限于所需范围并且连接经过加密,就可以是安全的。请检查哪些集成有权访问您的店铺,并移除不再使用的集成。

相关术语

在 BlackAha 中, Store Platform Integration 可帮助您连接店铺,自动同步商品价格。

返回定价词典