使用 Omnisend 的 API 连接自定义电子商务平台(如 Magento 或 OpenCart),或构建高级集成,以便在您的店铺和 Omnisend 之间传递联系人、订单、产品和事件数据。
本文将说明何时使用 API、其功能以及应遵循的集成指南。
开始之前
✅ 本指南适用于:
Magento、OpenCart 或定制电商平台
构建第三方应用集成的开发者
高级用户添加自定义功能 (webhooks, 自定义事件)
❌ 不适用于:
Shopify、WooCommerce 或 BigCommerce(这些平台会自动集成 – 无需 API 设置)
先决条件:
生成 API密钥(API Key)(所有 API 请求的必需项)
具备基本的 REST API 和 JSON 知识(或聘请一位开发人员)
访问您的店铺后端/代码
什么是 Omnisend API?
Omnisend API 可让您的店铺或应用自动将数据发送至 Omnisend – 无需手动上传。
例如,当客户下订单时,API 会将订单详情传递给 Omnisend,以便您能够触发条件(Trigger)订单确认电子邮件。或者,当访客浏览产品时,API 会跟踪其活动以用于浏览放弃工作流。
Omnisend 提供两种 API 类型:
REST API – 在您的店铺后端和 Omnisend 之间传递数据(联系人、订单、产品、事件)。
JavaScript API – 跟踪网站活动(页面浏览、产品浏览、添加到购物车),用于行为工作流。
何时使用 API
在以下情况使用 API:
您运营一个自建的电商平台(非 Shopify/WooCommerce/BigCommerce)。
您正在Magento、OpenCart或其他没有原生 Omnisend 插件的平台上。
您想要构建自定义集成(例如,从 CRM 同步联系人,根据应用事件触发工作流)。
您需要高级功能,例如 webhooks、自定义事件跟踪或实时数据同步。
在以下情况下,请勿使用 API:
您正在使用 Shopify、WooCommerce 或 BigCommerce – 请改用原生插件(设置更快,无需编码)。
入门
第 1 步。查看 API 文档:
快速入门指南 – REST API 基础知识(身份验证、端点、请求格式)。
JavaScript API 指南 – 网站跟踪设置。
第 2 步。生成 API密钥(API Key):
请按照本指南创建具有正确权限的密钥(联系人、订单、产品、Events)。
步骤 3. 测试您的集成:
使用API 日志(店铺设置 → API 日志)来调试请求,并确认数据是否正确传递。
特定功能集成指南
一旦您的基本 API 连接正常工作,请完成这些指南,以启用特定的 Omnisend 功能:
联系人和数据同步。 将联系人信息传送至 Omnisend– 同步订阅者列表、添加自定义属性、更新联系人资料。
订单 & 购物车挽回:
启用废弃购物车(Abandoned Cart)工作流 – 传递购物车数据以触发废弃购物车(Abandoned Cart)邮件/短信。
启用订单确认和发货确认工作流 – 传递订单数据以作为交易邮件的触发条件(Trigger)。
产品跟踪:
设置 Product Picker – 让您可以在 Omnisend邮件构建器(Email Builder)和自动化流程(Automation)工作流中选择产品。
启用产品放弃和浏览放弃工作流 – 跟踪产品浏览和购物车添加。
自定义事件。 为自动化流程(Automation)触发自定义事件– 传递自定义数据(例如,“trial started”、“subscription renewed”)以触发工作流。
分析与报告 (测试版)。 使用 Statistics API 导出分析数据– 查询营销活动(Campaign)和工作流(Workflow)表现、互动指标、收入归因、送达率(Deliverability)以及受众增长数据,以用于商业智能 (BI) 工具、自定义仪表板或数据仓库集成。
常见问题
使用 API 需要编程技能吗?
是您需要了解 REST API、JSON 和您店铺的后端代码。如果您不是开发人员,请聘请一位或使用原生集成 (Shopify/WooCommerce/BigCommerce)。
REST API 和 JavaScript API 之间有什么区别?
REST API 在服务器之间传递数据(联系人、订单、产品)
JavaScript API 可跟踪您网站上的用户行为(页面浏览、产品浏览、添加到购物车)
大多数集成两者都使用。
我可以将 API 与原生集成一同使用吗?
是例如,Shopify 用户可以使用 JavaScript API 来跟踪自定义事件,尽管核心集成(订单、联系人)是自动的。
我该如何排查 API 错误?
检查API日志(店铺设置 → API日志),用于查看请求/响应详情。常见问题:不正确的API密钥(API Key)、缺少必填字段和超出速率限制。
还有其他问题吗? 请联系我们[email protected] 或应用内聊天。
