SocialHub.AI
资源·开发者

REST API 参考

跨 19 资源的 71 端点。 SocialHub v2 REST API 可让您管理商店、忠诚会员、积分、优惠券、捕获、大使计划和跟踪。除非另有说明,所有端点都需要 Authorization: Bearer fl_live_…。

基本 URLhttps://flash.socialhub.ai/api/v2

此参考镜像了实时 API。 它是按资源分组的端点目录的静态快照。如需查看始终保持最新且机器可读的合约(参数、请求体、响应模式),请参阅 OpenAPI JSON →

身份验证

使用 Bearer 密钥进行身份验证

每个请求都会使用 SocialHub API 密钥 (fl_live_…) 进行身份验证,该密钥以 Bearer 令牌的形式发送。密钥的作用域限定于您的团队和每个工具——您可以在 SocialHub 帐户中创建和管理它们。

curl https://flash.socialhub.ai/api/v2/members \
  -H "Authorization: Bearer fl_live_your_key_here"

不想让明文密钥出现在 shell 历史记录中?您可以将其导出为 FLASH_API_KEY 并引用环境变量。

测试模式(沙盒)

将密钥标记为 测试密钥,即可在同一基础 URL 的沙箱环境中构建测试环境——无需单独的环境或凭据。使用该密钥写入的数据(会员、订单、优惠券)将被标记并从您的实际列表和仪表板中隐藏;测试会员不会被实际联系(营销邮件、短信和推送通知均会被屏蔽),测试优惠券也不会兑换任何实际价值;只需一个 POST /api/v2/test-data/purge 即可清除所有数据。您可以随意进行实验,然后重置。

参考资料

端点

跨 19 资源组的 71 端点。每个端点包含方法、路径和一行摘要——完整的参数和架构详情位于 OpenAPI JSON 中。

CWM 预测

4 端点s

CWM's 单一最终下一事件分配, TimesFM 2.5 需求预测和租户私有融合窗口。下一步行为要求 predictions:read趋势/窗口也需要 metrics:read下一事件概率未经校准,且取决于支持的目标;融合窗口仍然存在。 null 直到经过培训和验证。

GET/api/v2/cwm/capabilities
GET/api/v2/cwm/members/{id}/next-behaviors
GET/api/v2/cwm/trends
GET/api/v2/cwm/members/{id}/purchase-windows

门店

4 端点s

门店管理

GET/api/v2/stores
GET/api/v2/stores/{id}
POST/api/v2/stores
PUT/api/v2/stores/{id}

会员

12 端点s

会员管理

GET/api/v2/members
POST/api/v2/members
POST/api/v2/members/batch
GET/api/v2/members/{id}
补丁/api/v2/members/{id}
GET/api/v2/members/{id}/points
POST/api/v2/members/{id}/points
GET/api/v2/members/{id}/tier
GET/api/v2/members/{id}/coupons
GET/api/v2/members/{id}/receipts
GET/api/v2/members/{id}/profile
POST/api/v2/members/{id}/redeem-coupon

订单

4 端点s

订单导入 → 自动奖励积分、退款和对账

GET/api/v2/orders
POST/api/v2/orders
POST/api/v2/orders/batch
POST/api/v2/orders/{externalOrderId}/refund

产品目录

5 端点s

产品目录 (PIM)——产品、变体、类别、品牌;通用 ERP/Shopify 导入

GET/api/v2/products
GET/api/v2/products/{id}
GET/api/v2/categories
GET/api/v2/brands
POST/api/v2/catalog/import

会员标签

4 端点s

阅读标签目录——生命周期、RFM、价值层、参与度、购买时机、偏好(包括类别亲和力)、风险、同意和渠道轴——并手动分配/删除成员的标签

GET/api/v2/tags
GET/api/v2/members/{id}/tags
POST/api/v2/members/{id}/tags
删除/api/v2/members/{id}/tags/{tagKey}

自定义字段

2 端点s

读取租户定义的任何实体(会员/商店/产品/优惠券池/订单)的自定义字段。只读;设计上不涉及个人身份信息 (PII)。权限范围:custom_fields:read。

GET/api/v2/custom-fields
GET/api/v2/custom-fields/values

捕获

1 端点

捕获记录

GET/api/v2/captures

优惠券

4 端点s

优惠券池、代码和兑换

GET/api/v2/coupons
GET/api/v2/coupons/pools
POST/api/v2/coupons/issue
POST/api/v2/coupons/{id}/redeem

大使计划

3 端点s

大使计划 — 候选人、投资回报率报告和联盟代码

GET/api/v2/ambassador/candidates
GET/api/v2/ambassador/metrics
POST/api/v2/ambassador/members/{id}/issue-code

追踪

2 端点s

页面访问/行为分析和事件采集

GET/api/v2/tracking/stats
POST/api/v2/tracking/events

API 关键信息

3 端点s

API 密钥管理

GET/api/v2/api-keys
POST/api/v2/api-keys
删除/api/v2/api-keys/{id}

授权

7 端点s

身份验证和用户个人资料

POST/api/v2/auth/register
POST/api/v2/auth/login
GET/api/v2/auth/profile
补丁/api/v2/auth/profile
POST/api/v2/auth/change-password
POST/api/v2/auth/forgot-password
POST/api/v2/auth/reset-password

细分市场

5 端点s

受众细分 — 用于定向广告活动的结构化条件。

GET/api/v2/segments
POST/api/v2/segments
GET/api/v2/segments/{id}
补丁/api/v2/segments/{id}
删除/api/v2/segments/{id}

营销活动

3 端点s

营销活动——列出并创建草稿(不会发送;由人工审核后发送)

GET/api/v2/campaigns
POST/api/v2/campaigns
GET/api/v2/campaigns/{id}

自动化

2 端点s

自动化 - 列出事件触发的流程并暂停/恢复它们

GET/api/v2/automations
补丁/api/v2/automations/{id}

交易型

1 端点

事务性发送 — 您的系统触发向单个收件人发送由用户明确启用事务性用途(订单确认、收据)的营销活动。API 永远不会创建内容;始终遵守送达率抑制;传递 idempotency_key 以确保重试安全

POST/api/v2/transactional/send

进口

4 端点s

异步批量导入——上传 CSV/JSONL 会员/订单文件并轮询作业(无 100 行上限)

POST/api/v2/members/import
GET/api/v2/members/import/{id}
POST/api/v2/orders/import
GET/api/v2/orders/import/{id}

测试数据

1 端点

沙盒测试模式数据 — 清除测试密钥创建的所有内容

POST/api/v2/test-data/purge
近期发货

预测性配置文件字段和更智能的推荐

两项升级将应用于现有端点内部——没有新增公共接口,现有推荐端点的响应结构保持不变。

GET /api/v2/members/{id}/profile

配置文件汇总现在包括预测字段,当团队数据支持拟合时计算:

  • 预计下次下单日期——基于会员自身购买间隔(需至少购买 3 次)的 Gamma 拟合,返回间隔统计数据和置信度指标。
  • 电子邮件点击倾向 — 来自个人资料汇总互动功能的团队 L2 正则化逻辑 P(click)。

两个字段都位于诚信门下方的 null 之下——绝非猜测。 消费者必须处理null。

Recommendations (public embed + v2)

共同购买评分已升级为余弦归一化商品相似度,因此配对强度不再受畅销商品主导:

score = co_count / sqrt(buyers(A) × buyers(B))   # pairs need ≥2 shared buyers
                                                 # raw co_count still stored

新的每日 作业按团队运行(支持度/置信度/提升度;MIN_PAIR_ORDERS=3、MIN_CONFIDENCE=0.05,每个前提词的前 25 条提升度规则),并提供交叉销售建议。现有集成继续按原样运行——响应结构保持不变。