REST API 参考
跨 19 资源的 71 端点。 SocialHub v2 REST API 可让您管理商店、忠诚会员、积分、优惠券、捕获、大使计划和跟踪。除非另有说明,所有端点都需要 Authorization: Bearer fl_live_…。
https://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 端点sCWM's 单一最终下一事件分配, TimesFM 2.5 需求预测和租户私有融合窗口。下一步行为要求 predictions:read趋势/窗口也需要 metrics:read下一事件概率未经校准,且取决于支持的目标;融合窗口仍然存在。 null 直到经过培训和验证。
/api/v2/cwm/capabilities/api/v2/cwm/members/{id}/next-behaviors/api/v2/cwm/trends/api/v2/cwm/members/{id}/purchase-windows门店
4 端点s门店管理
/api/v2/stores/api/v2/stores/{id}/api/v2/stores/api/v2/stores/{id}会员
12 端点s会员管理
/api/v2/members/api/v2/members/api/v2/members/batch/api/v2/members/{id}/api/v2/members/{id}/api/v2/members/{id}/points/api/v2/members/{id}/points/api/v2/members/{id}/tier/api/v2/members/{id}/coupons/api/v2/members/{id}/receipts/api/v2/members/{id}/profile/api/v2/members/{id}/redeem-coupon订单
4 端点s订单导入 → 自动奖励积分、退款和对账
/api/v2/orders/api/v2/orders/api/v2/orders/batch/api/v2/orders/{externalOrderId}/refund产品目录
5 端点s产品目录 (PIM)——产品、变体、类别、品牌;通用 ERP/Shopify 导入
/api/v2/products/api/v2/products/{id}/api/v2/categories/api/v2/brands/api/v2/catalog/import自定义字段
2 端点s读取租户定义的任何实体(会员/商店/产品/优惠券池/订单)的自定义字段。只读;设计上不涉及个人身份信息 (PII)。权限范围:custom_fields:read。
/api/v2/custom-fields/api/v2/custom-fields/values捕获
1 端点捕获记录
/api/v2/captures优惠券
4 端点s优惠券池、代码和兑换
/api/v2/coupons/api/v2/coupons/pools/api/v2/coupons/issue/api/v2/coupons/{id}/redeem大使计划
3 端点s大使计划 — 候选人、投资回报率报告和联盟代码
/api/v2/ambassador/candidates/api/v2/ambassador/metrics/api/v2/ambassador/members/{id}/issue-code追踪
2 端点s页面访问/行为分析和事件采集
/api/v2/tracking/stats/api/v2/tracking/eventsAPI 关键信息
3 端点sAPI 密钥管理
/api/v2/api-keys/api/v2/api-keys/api/v2/api-keys/{id}授权
7 端点s身份验证和用户个人资料
/api/v2/auth/register/api/v2/auth/login/api/v2/auth/profile/api/v2/auth/profile/api/v2/auth/change-password/api/v2/auth/forgot-password/api/v2/auth/reset-password细分市场
5 端点s受众细分 — 用于定向广告活动的结构化条件。
/api/v2/segments/api/v2/segments/api/v2/segments/{id}/api/v2/segments/{id}/api/v2/segments/{id}营销活动
3 端点s营销活动——列出并创建草稿(不会发送;由人工审核后发送)
/api/v2/campaigns/api/v2/campaigns/api/v2/campaigns/{id}自动化
2 端点s自动化 - 列出事件触发的流程并暂停/恢复它们
/api/v2/automations/api/v2/automations/{id}交易型
1 端点事务性发送 — 您的系统触发向单个收件人发送由用户明确启用事务性用途(订单确认、收据)的营销活动。API 永远不会创建内容;始终遵守送达率抑制;传递 idempotency_key 以确保重试安全
/api/v2/transactional/send进口
4 端点s异步批量导入——上传 CSV/JSONL 会员/订单文件并轮询作业(无 100 行上限)
/api/v2/members/import/api/v2/members/import/{id}/api/v2/orders/import/api/v2/orders/import/{id}测试数据
1 端点沙盒测试模式数据 — 清除测试密钥创建的所有内容
/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 条提升度规则),并提供交叉销售建议。现有集成继续按原样运行——响应结构保持不变。