使用 SmartPush Open API 上报联系人与自定义事件

SmartPush 现已支持 Open API 集成，商家可通过该接口从外部系统（如第三方 CRM、自建网站或其他平台）上报用户数据与自定义事件。

通过将外部数据源连接至 SmartPush，您可以：

• 根据自定义事件触发自动化任务；
• 通过自定义属性与事件筛选构建目标受众；
• 基于整合数据开展跨渠道精准营销。

注意: 

• 此功能仅适用于 Standard 及以上方案。
• 此功能目前仅对白名单用户开放。如您有兴趣使用该功能，请联系团队协助将您的商店加入白名单。

目录

• SmartPush Open API 的重要性

• 使用场景

• 如何设置并使用 SmartPush Open API

• 注意事项与限制

 

SmartPush Open API 的重要性

许多商家同时运营多个数据系统，例如 CRM、自建站或外部营销工具。若这些系统未打通，数据将处于割裂状态，无法统一分析与运营。

通过 SmartPush Open API，您可以将多渠道数据整合至同一个 SmartPush 工作区，从而：

• 根据自定义业务事件触发自动化流程；
• 使用导入的属性筛选并分析客户群体；
• 获取更深入的用户洞察，实现个性化营销。

---

使用场景及操作流程

场景/步骤	描述
1. 添加开发者授权	店主为开发者账号授予 “Developer” 权限，开发者可前往 SmartPush > 设置 > API 获取 API Token。
2. 添加自定义用户属性	开发者可通过 Profile API 创建或更新联系人信息，并添加新的用户属性（如会员等级、来源平台等）。
3. 添加自定义指标与事件属性	开发者可通过 Custom Metric API 创建自定义事件与事件属性（如网络研讨会注册、线下购买）。
4. 筛选自定义用户属性	所有有权限的用户可在 Segments 中使用这些属性，构建邮件、短信或自动化营销的目标受众。
5. 基于自定义事件进行营销自动化	可将上报的事件作为自动化触发条件，并结合用户属性建立精准的营销流程。

示例：

• 某品牌自建站将用户行为上报至 SmartPush，用于发送个性化的购买后关怀邮件。
• 某商家将外部行为数据（如 App 使用或活动参与）接入 SmartPush，用于触发后续的精准营销活动。
  
   

---

如何设置并使用 SmartPush Open API

Step 1. 授权开发者账号

1. 前往 SmartPush > 店铺管理 > 店铺权限管理 > 店铺权限管理 > 添加授权用户。
2. 为开发者账号分配 Developer（开发者）角色。
   
3. 在 SmartPush > 设置 > 数据 ＆API > API 访问令牌 中查看并复制 API 密钥。
   
   

重要：仅店主与开发者角色可查看 API Token，其他角色将显示权限提示。

Step 2. 通过 Profile API 上报联系人与属性

• 接口路径： POST /createContact
• 用途： 创建或更新联系人身份与属性。
• 支持字段类型： String、Integer、Float、Boolean、Date
• 命名规则： email 不区分大小写，其他字段区分大小写。
• 限制： 每个店铺最多可定义 20 个自定义属性（默认以 cus_ 为前缀）。
  
   

注意：姓名、地址、电话、身份证号等敏感信息将自动加密。

Step 3. 通过 Custom Metric API 上报自定义事件

• 接口路径： POST /createCustomMetric
• 用途： 创建新的事件类型与事件属性，用于追踪行为数据。
• 限制：
  • 每个店铺最多可创建 50 个自定义事件；
  • 每个事件最多支持 20 个事件属性；
  • 重复的 EventCode 将被拒绝创建。

Step 4. 在 SmartPush 中查看与管理数据

在 SmartPush > 联系人 > 细分群组 中：

• 自定义用户属性显示在「自定义用户属性管理」中。
• 可在 Segments > 基础属性 > 自定义属性 中按自定义字段筛选目标用户。
• 在 Segments > 其他 > API 标签 下查看 API 上报标签。

在 SmartPush > 指标 中：

• 在新的 API 分类 下查看上报的自定义事件。
• 查看事件状态（待同步 / 同步中 / 已暂停）。
• 编辑或删除不再使用的事件与属性。

在 SmartPush > 自动化 中：

• 选择 API Trigger 作为触发事件。
• 根据上报的用户属性或事件属性设置过滤条件。
• 示例：当检测到上报的 “线下购买” 事件时，触发 EDM 邮件发送。
   

---

注意事项与限制

• 每个店铺最多可添加 20 个自定义用户属性 与 50 个自定义事件。
• 删除的属性或事件将自动从相关的 群组 与 自动化任务 中移除。
• 上报的数据仅保存在 SmartPush 中，不会同步回主站联系人列表。
• 为确保隐私安全，SmartPush 会自动加密所有包含个人信息的字段（如邮箱、电话、地址等）。