REST API リファレンス
19 リソースにわたる 71 エンドポイント。 SocialHub v2 REST API を使用すると、ストア、ロイヤルティ メンバー、ポイント、クーポン、キャプチャ、アンバサダー プログラム、および追跡を管理できます。特に明記されていない限り、すべてのエンドポイントには Authorization: Bearer fl_live_… が必要です。
https://flash.socialhub.ai/api/v2この参照は、ライブ API を反映しています。 これは、リソースごとにグループ化されたエンドポイント カタログの静的スナップショットです。常に最新の機械可読コントラクト (パラメータ、リクエスト本文、レスポンス スキーマ) については、OpenAPI JSON → を参照してください。
Bearer キーで認証する
すべてのリクエストは、Bearer トークンとして送信された SocialHub API キー (fl_live_…) で認証されます。キーのスコープはチームおよびツールごとに設定されており、SocialHub アカウントでキーを作成して管理します。
curl https://flash.socialhub.ai/api/v2/members \
-H "Authorization: Bearer fl_live_your_key_here"平文キーをシェル履歴に含めないほうがよいですか?これを FLASH_API_KEY としてエクスポートし、環境変数を参照します。
キーを テストキー としてマークすると、同じベース URL 上のサンドボックスに対してビルドを実行できます。別の環境や認証情報は不要です。このキーで書き込まれたデータ (メンバー、注文、クーポン) はタグ付けされ、ライブ リストやダッシュボードには表示されません。テスト メンバーには実際には連絡が取られず (マーケティング メール、SMS、プッシュ通知は抑制されます)、テスト クーポンは実際の価値に交換されることはありません。また、POST /api/v2/test-data/purge を 1 つ実行すると、すべてのデータが消去されます。自由にテストして、リセットしてください。
エンドポイント
19 リソース グループ全体の 71 エンドポイント。メソッド、パス、およびそれぞれの 1 行の概要。完全なパラメータとスキーマの詳細は OpenAPI JSON にあります。
CWM 予報
4 エンドポイントsCWMの単一の最終次イベント分布、 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アンバサダー プログラム — 候補者、ROI レポート、およびアフィリエイト コード
/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予測プロファイルフィールドとよりスマートな推奨事項
2 つのアップグレードは既存のエンドポイント内に配置されます。新しい公開サーフェスはなく、既存の推奨エンドポイントの応答形状は変更されません。
GET /api/v2/members/{id}/profileプロファイル ロールアップには、チームのデータが適合をサポートするときに計算される予測フィールドが含まれるようになりました。
- 次回の注文予定日 — メンバー自身の購入間隔 (3 回以上の購入が必要) に適合したメンバーごとのガンマ値。間隔統計と信頼性指標とともに返されます。
- メールのクリック傾向 — プロファイルのロールアップ エンゲージメント機能からのチームごとの 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 ルール)、クロスセルの提案を提供します。既存の統合はそのまま動作し続けます。応答の形状は変更されません。