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 條提升度規則),並提供交叉銷售建議。現有整合繼續按原樣運作——響應結構保持不變。