Kaynaklar · Geliştiriciler

REST API Referans

19 kaynaklarındaki 71 uç noktaları. SocialHub v2 REST API mağazaları, sadakat üyelerini, puanları, kuponları, kapları, Elçi programını ve takibi yönetmenizi sağlar. Aksi belirtilmediği sürece tüm uç noktalar Authorization: Bearer fl_live_… gerektirir.

Temel URLhttps://flash.socialhub.ai/api/v2

OpenAPI JSON Claude (SoCode) konumundan çalıştır

Bu referans, canlı API'yi yansıtır. Kaynağa göre gruplandırılmış uç nokta kataloğunun statik bir anlık görüntüsüdür. Her zaman güncel, makine tarafından okunabilir sözleşme (parametreler, istek gövdeleri, yanıt şemaları) için OpenAPI JSON → bölümüne bakın.

Kimlik Doğrulama

Taşıyıcı anahtarla kimlik doğrulama

Her istek, Taşıyıcı belirteç olarak gönderilen bir SocialHub API anahtarı (fl_live_…) ile doğrulanır. Anahtarlar ekibinize ve araç başına özeldir; bunları SocialHub hesabınızda oluşturun ve yönetin.

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

Düz metin anahtarını shell geçmişinizden uzak tutmayı mı tercih ediyorsunuz? FLASH_API_KEY olarak dışa aktarın ve ortam değişkenine referans verin.

Test modu (kum havuzu)

Aynı temel URL üzerinde bir sanal ortamda derleme yapmak için bir anahtarı test anahtarı olarak işaretleyin — ayrı bir ortam veya kimlik bilgisi gerekmez. Bununla yazılan veriler (üyeler, siparişler, kuponlar) etiketlenir ve canlı listelerinizden ve gösterge panolarınızdan gizlenir; bir test üyesiyle asla gerçek anlamda iletişim kurulmaz (pazarlama e-postası, SMS ve bildirimler engellenir) ve bir test kuponu asla gerçek bir değer için kullanılmaz; ve tek bir POST /api/v2/test-data/purge komutu her şeyi siler. Özgürce deney yapın, sonra sıfırlayın.

API Anahtarlarını Yönetin

Referans

Uç noktalar

19 kaynak grupları genelinde 71 uç noktaları. Her biri için yöntem, yol ve tek satırlık özet — tam parametre ve şema ayrıntıları OpenAPI JSON dosyasında bulunur.

CWM Tahminler

4 uç noktasıS

CWM'ın tek ve son bir sonraki etkinlik dağıtımı, TimesFM 2.5 talep tahminleri ve kiracı-özel sektör birleşme pencereleri. Sonraki davranışlar gerektirir predictions:read; trendler/vitrinler ayrıca şunları gerektirir: metrics:readSonraki olay olasılıkları kalibre edilmemiş olup desteklenen hedeflere bağlıdır; birleştirme pencereleri aynı kalır. null Eğitimini tamamlayıp onaylanana kadar.

GET/api/v2/cwm/capabilitiesTrend/kantil kullanılabilirlik ve kiracı 7/30/90 günlük birleştirme hazırlığını okuyun (predictions:read)

GET/api/v2/cwm/members/{id}/next-behaviorsBir üyenin yanıtı, sonraki etkinliğin dağıtımı/sıralaması ve otomatik olarak gerçekleşir. CWM + TimesFM 7/30/90d purchaseWindowsOlay olasılıkları kalibre edilmemiştir; satın alma zaman aralıkları null Eğitim/onay süreci tamamlanana kadar (predictions:read; metrics:read (ayrıca pencereleri etkinleştirir)

GET/api/v2/cwm/trendsTahmin günlük marka/kategori metrikleri: nokta + kalibre edilmemiş q10..q90; eksik günler müsait değil

GET/api/v2/cwm/members/{id}/purchase-windowsKiracı-özel 7/30/90 günlük satın alma olasılıkları (0–1), null eğitilip doğrulanana kadar

Mağazalar

4 uç noktasıS

Mağaza yönetimi

GET/api/v2/storesMağazaları listele (filtrele) externalId / updatedSince)

GET/api/v2/stores/{id}Mağazayı kimliğe göre al

POST/api/v2/storesBir mağaza oluşturun veya güncelleyin (şekilde) externalId)

PUT/api/v2/stores/{id}Bir mağazayı güncelle

Üyeler

12 uç noktasıS

Sadakat üyesi yönetimi

GET/api/v2/membersÜyeleri listele / ara (e-posta, externalId, updatedSince)

POST/api/v2/membersÜye oluşturma veya ekleme/çıkarma işlemi (şekilde) externalId / e-posta)

POST/api/v2/members/batchToplu üye oluşturma/güncelleme (≤100, 207)

GET/api/v2/members/{id}Üyeyi kimlik numarasıyla bulun

YAMA/api/v2/members/{id}Üyenin profilini/kimliğini güncelleme

GET/api/v2/members/{id}/pointsÜye puan bakiyesini alın

POST/api/v2/members/{id}/pointsPuan kazanma / kullanma / tersine çevirme

GET/api/v2/members/{id}/tierÜye kademesini alın

GET/api/v2/members/{id}/couponsÜye kuponları alın

GET/api/v2/members/{id}/receiptsÜye makbuzlarını alın

GET/api/v2/members/{id}/profileBir üyenin toplu profilini alın: ulaşılabilirlik, izin/CCPA, bağlılık, ticaret/katılım özetleri + tahmin alanları (beklenen sonraki sipariş tarihi, e-posta tıklama eğilimi; veri kapılarının altında boş), tercihler, etiketler (salt okunur, PII-düzenlenmiş)

POST/api/v2/members/{id}/redeem-couponPuanları kupona dönüştürün

Siparişler

4 uç noktasıS

Sipariş alımı → otomatik ödül puanları, iadeler ve mutabakat

GET/api/v2/ordersAlınan siparişleri listele (üye / externalId / updatedSince'e göre filtrele)

POST/api/v2/ordersBir siparişi al ve otomatik olarak puan ver

POST/api/v2/orders/batchToplu sipariş alımı (≤100, 207)

POST/api/v2/orders/{externalOrderId}/refundSipariş iadesi (orantılı puan geri alma)

Katalog

5 uç noktasıS

Ürün kataloğu (PIM) — ürünler, varyantlar, kategoriler, markalar; genel ERP/Shopify içe aktarma

GET/api/v2/productsÜrünleri listele (durum / kategori / marka / sektöre göre filtrele)

GET/api/v2/products/{id}Çeşitleri, medyası ve içeriği olan bir ürün edinin

GET/api/v2/categoriesÜrün kategorilerini listele

GET/api/v2/brandsMarkaları Listele

POST/api/v2/catalog/importGenel güncelleme — markalar/kategoriler/ürünler/varyantlar/envanter tarafından external_id

Üye Etiketleri

4 uç noktasıS

Etiket kataloğunu okuyun (yaşam döngüsü, RFM, değer katmanı, etkileşim, satın alma zamanlaması, tercih (kategori yakınlığı dahil), risk, izin ve kanal eksenleri) ve bir üyenin etiketlerini manuel olarak atayın/kaldırın

GET/api/v2/tagsListe etiketi tanımları (kural odaklı eksenler + boolean durum etiketleri)

GET/api/v2/members/{id}/tagsÜyenin etiketlerini listele

POST/api/v2/members/{id}/tagsBir üyeye etiket atayın (tagKey ile)

SİL/api/v2/members/{id}/tags/{tagKey}Bir üyenin etiketini kaldırma

Özel Alanlar

2 uç noktasıS

Herhangi bir varlık (üye / mağaza / ürün / kupon havuzu / sipariş) için kiracı tarafından tanımlanan özel alanları okuyun. Sadece okunabilir; tasarım gereği kişisel bilgi içermez. Kapsam: custom_fields:read.

GET/api/v2/custom-fieldsBir varlık için özel alan tanımlarını listeler (?entity=member|store|product|coupon_pool|order)

GET/api/v2/custom-fields/valuesBir kaydın özel alan değerlerini alın (?entity=…&entityId=…)

Yakalamalar

1 uç noktası

Kayıtları yakala

GET/api/v2/capturesListe yakalamaları

Kuponlar

4 uç noktasıS

Kupon havuzları, kodlar ve kullanım

GET/api/v2/couponsKuponları Listele

GET/api/v2/coupons/poolsKupon havuzlarını listele

POST/api/v2/coupons/issueKupon oluşturma

POST/api/v2/coupons/{id}/redeemKupon kullanın

Büyükelçi

3 uç noktasıS

Elçi programı — adaylar, yatırım getirisi raporu ve ortaklık kodları

GET/api/v2/ambassador/candidatesListe Elçisi adayları

GET/api/v2/ambassador/metricsElçi ROI raporunu alın

POST/api/v2/ambassador/members/{id}/issue-codeBir Elçi ortaklık kodu verin

Takip

2 uç noktasıS

Sayfa ziyareti / davranış analizi ve olay alımı

GET/api/v2/tracking/statsSayfa ziyareti/davranış analizlerini alın

POST/api/v2/tracking/eventsSayfa görüntüleme/izleme olayını kaydedin

API Tuşlar

3 uç noktasıS

API anahtar yönetimi

GET/api/v2/api-keysAPI anahtarlarını listele

POST/api/v2/api-keysAPI anahtarını oluşturun

SİL/api/v2/api-keys/{id}API tuşunu silin

Yetki

7 uç noktasıS

Kimlik doğrulama ve kullanıcı profili

POST/api/v2/auth/registerKayıt olmak

POST/api/v2/auth/loginGiriş yapın

GET/api/v2/auth/profileProfil alın

YAMA/api/v2/auth/profileProfilinizi güncelleyin

POST/api/v2/auth/change-passwordŞifre değiştir

POST/api/v2/auth/forgot-passwordŞifremi unuttum

POST/api/v2/auth/reset-passwordŞifre sıfırlama

Segmentler

5 uç noktasıS

Hedef Kitle Segmentleri — Kampanyaları Hedeflemek İçin Kullanılan Yapılandırılmış Koşullar

GET/api/v2/segmentsKitle segmentlerini listeleyin

POST/api/v2/segmentsYapılandırılmış koşullardan (SQL değil) bir segment oluşturun

GET/api/v2/segments/{id}Bir segment alın

YAMA/api/v2/segments/{id}Bir segmenti güncelleyin

SİL/api/v2/segments/{id}Bir segmenti arşivleyin (yumuşak)

Kampanyalar

3 uç noktasıS

Kampanyalar — liste ve taslak oluşturma (asla gönderilmez; bir insan inceler ve gönderir)

GET/api/v2/campaignsKampanyaları listele

POST/api/v2/campaignsBir kampanya TASLAĞI oluşturun (asla göndermez; bir şablondan/kaynaktan)

GET/api/v2/campaigns/{id}Bir kampanya başlatın

Otomasyonlar

2 uç noktasıS

Otomasyonlar — olayla tetiklenen akışları listeleyin ve bunları duraklatın/devam ettirin

GET/api/v2/automationsOtomasyonları ve durumlarını listele

YAMA/api/v2/automations/{id}Otomasyonu duraklat veya devam ettir

İşlemsel

1 uç noktası

İşlemsel gönderim — sisteminiz, işlemsel kullanım için açıkça yetkilendirilmiş bir insan tarafından (sipariş onayları, makbuzlar) tek alıcılı bir kampanya gönderimini tetikler. API asla içerik oluşturmaz; teslim edilebilirlik bastırması her zaman dikkate alınır; Tekrar denemeleri güvenli hale getirmek için idempotency_key'i geçirin

POST/api/v2/transactional/sendBirleştirilmiş verilerle etkin bir kampanyayı tek bir alıcıya gönderin

İçe aktarmalar

4 uç noktasıS

Asenkron Toplu İçe Aktarma — Bir CSV/JSONL üye/sipariş dosyasını yükleyin ve işi sorgulayın (100 satır sınırı yok)

POST/api/v2/members/importAsenkron üye içe aktarma işlemini sıraya alın (CSV/JSONL)

GET/api/v2/members/import/{id}Bir üyeyi anketle içe aktarma işinin durumunu/ilerlemesini kontrol et

POST/api/v2/orders/importAsenkron sipariş içe aktarma sıraya alın (CSV/JSONL)

GET/api/v2/orders/import/{id}Sipariş içe aktarma işinin durumunu/ilerlemesini sorgulayın

Test verileri

1 uç noktası

Test modu verilerini sanal ortamda saklayın — bir test anahtarının oluşturduğu her şeyi temizleyin

POST/api/v2/test-data/purgeTakımın tüm test modu verilerini kalıcı olarak silin

Son zamanlarda gönderilenler

Tahminleyici profil alanları ve daha akıllı öneriler

İki yükseltme mevcut uç noktaların içine giriyor; yeni bir genel yüzey yok ve mevcut öneri uç noktalarının yanıt şekilleri değişmedi.

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

Profil özetleri artık takımın verileri bir uyumu desteklediğinde hesaplanan tahminli alanları içeriyor:

Beklenen bir sonraki sipariş tarihi — üyenin kendi satın alma aralıklarına göre üye başına Gama uyumu (≥ 3 satın alma gerektirir), aralık istatistikleri ve bir güven göstergesi ile birlikte döndürülür.
E-posta tıklama eğilimi — profilin toplu etkileşim özelliklerinden gelen, ekip başına L2 düzenlemeli bir lojistik P(click).

Her iki alan da dürüstlük kapılarının null altındadır; asla tahmin edilemez. Tüketiciler null değerini işlemelidir.

Recommendations (public embed + v2)

Ortak satın alma puanlaması, kosinüs normalleştirilmiş ürün-ürün benzerliğine yükseltildi, böylece çift gücü artık en çok satanlar tarafından domine edilmiyor:

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

Her ekip için (destek / güven / yükseliş; MIN_PAIR_ORDERS=3, MIN_CONFIDENCE=0.05, yükselişe göre öncül başına en iyi 25 kural) yeni bir gece işi çalıştırılır ve çapraz satış önerileri sunar. Mevcut entegrasyonlar olduğu gibi çalışmaya devam eder — yanıt şekilleri değişmez.

OpenAPI JSON (makine tarafından okunabilir)Claude (SoCode) konumundan çalıştır API Anahtarlarını Yönetin Kaynaklara Geri Dön