Ressourcen · Entwickler

REST API Referenz

71-Endpunkte über 19-Ressourcen hinweg. Mit dem SocialHub v2 REST API können Sie Geschäfte, Treuemitglieder, Punkte, Coupons, Erfassungen, das Ambassador-Programm und Tracking verwalten. Alle Endpunkte erfordern Authorization: Bearer fl_live_…, sofern nicht anders angegeben.

Basis-URLhttps://flash.socialhub.ai/api/v2

OpenAPI JSON Ausführen von Claude (SoCode)

Diese Referenz spiegelt die Live-Version von API wider. Es handelt sich um eine statische Momentaufnahme des Endpunktkatalogs, gruppiert nach Ressourcen. Den stets aktuellen, maschinenlesbaren Vertrag (Parameter, Anfragetexte, Antwortschemata) finden Sie unter OpenAPI JSON →.

Authentifizierung

Mit einem Bearer-Schlüssel authentifizieren

Jede Anfrage wird mit einem SocialHub-Schlüssel API (fl_live_…) authentifiziert, der als Bearer-Token gesendet wird. Die Schlüssel sind team- und toolbezogen – erstellen und verwalten Sie sie in Ihrem SocialHub-Konto.

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

Möchten Sie den Klartextschlüssel nicht in Ihrem Shell-Verlauf speichern? Exportieren Sie ihn als FLASH_API_KEY und referenzieren Sie die Umgebungsvariable.

Testmodus (Sandbox)

Markieren Sie einen Schlüssel als Testschlüssel, um ihn in einer Sandbox unter derselben Basis-URL zu testen – ohne separate Umgebung oder Zugangsdaten. Die damit erstellten Daten (Mitglieder, Bestellungen, Gutscheine) werden gekennzeichnet und in Ihren Live-Listen und Dashboards ausgeblendet. Ein Testmitglied wird nie kontaktiert (Marketing-E-Mails, SMS und Push-Benachrichtigungen werden unterdrückt), und ein Testgutschein kann nie eingelöst werden. Ein einziger Klick auf POST /api/v2/test-data/purge löscht alle Daten. Experimentieren Sie nach Belieben und setzen Sie die Einstellungen anschließend zurück.

API-Schlüssel verwalten

Referenz

Endpunkte

71 Endpunkte in 19 Ressourcengruppen. Methode, Pfad und eine einzeilige Zusammenfassung für jeden Endpunkt – die vollständigen Parameter- und Schemadetails befinden sich in der OpenAPI-JSON-Datei.

CWM Prognosen

4 EndpunktS

CWMdie endgültige Verteilung des nächsten Ereignisses, TimesFM 2.5 Bedarfsprognosen und mieterspezifische Fusionsfenster. Next-Behaviors erfordert predictions:readTrends/Fenster erfordern ebenfalls metrics:readDie Wahrscheinlichkeiten für das nächste Ereignis sind unkalibriert und hängen von den unterstützten Zielen ab; Fusionsfenster bleiben bestehen. null bis zur Schulung und Validierung.

GET/api/v2/cwm/capabilitiesLesen Sie die Trend-/Quantilverfügbarkeit und die 7/30/90-Tage-Fusionsbereitschaft der Mandanten (predictions:read)

GET/api/v2/cwm/members/{id}/next-behaviorsEine Antwort eines Mitglieds mit Verteilung/Rangfolge des nächsten Ereignisses und automatischer CWM + TimesFM 7/30/90d purchaseWindowsEreigniswahrscheinlichkeiten unkalibriert; Kauffenster null bis zur Schulung/Validierung (predictions:read; metrics:read (aktiviert zusätzlich Windows)

GET/api/v2/cwm/trendsTägliche Marken-/Kategoriemetriken prognostizieren: Punkt + unkalibriertes q10..q90; Fehlende Tage bleiben nicht verfügbar

GET/api/v2/cwm/members/{id}/purchase-windowsKaufwahrscheinlichkeiten (0–1) für Mieter/Privatkunden (7/30/90 Tage), null bis zum Training und der Validierung

Filialen

4 EndpunktS

Filialverwaltung

GET/api/v2/storesGeschäfte auflisten (filtern nach) externalId / updatedSince)

GET/api/v2/stores/{id}Holen Sie sich den Store per ID

POST/api/v2/storesErstellen oder Aktualisieren eines Shops (durch externalId)

PUT/api/v2/stores/{id}Shop aktualisieren

Mitglieder

12 EndpunktS

Mitgliederverwaltung im Treueprogramm

GET/api/v2/membersMitglieder auflisten / suchen (E-Mail, externalId, updatedSince)

POST/api/v2/membersErstellen oder Aktualisieren eines Mitglieds (durch externalId / E-Mail)

POST/api/v2/members/batchMassenhaftes Erstellen/Einfügen von Mitgliedern (≤100, 207)

GET/api/v2/members/{id}Mitglieder anhand der ID abrufen

PATCH/api/v2/members/{id}Aktualisierung des Mitgliederprofils/der Identität

GET/api/v2/members/{id}/pointsMitgliederpunktestand abrufen

POST/api/v2/members/{id}/pointsPunkte sammeln / einlösen / stornieren

GET/api/v2/members/{id}/tierMitgliedsstatus abrufen

GET/api/v2/members/{id}/couponsHolen Sie sich Mitgliedergutscheine

GET/api/v2/members/{id}/receiptsMitgliederbelege erhalten

GET/api/v2/members/{id}/profileErhalten Sie das aggregierte Profil eines Mitglieds – Erreichbarkeit, Einwilligung/CCPA, Loyalität, Handels-/Engagement-Rollups + prädiktive Felder (erwartetes Datum der nächsten Bestellung, E-Mail-Klickneigung; Null unter Daten-Gates), Präferenzen, Tags (schreibgeschützt, PII-geschwärzt)

POST/api/v2/members/{id}/redeem-couponPunkte gegen Gutschein einlösen

Bestellungen

4 EndpunktS

Auftragserfassung → automatische Punktevergabe, Rückerstattungen und Abstimmung

GET/api/v2/ordersListe der aufgenommenen Bestellungen (nach Mitglied filtern) externalId / updatedSince)

POST/api/v2/ordersBestellung aufnehmen und Punkte automatisch vergeben

POST/api/v2/orders/batchMassenbestellungsaufnahme (≤100, 207)

POST/api/v2/orders/{externalOrderId}/refundRückerstattung einer Bestellung (anteilige Punkterückerstattung)

Katalog

5 EndpunktS

Produktkatalog (PIM) – Produkte, Varianten, Kategorien, Marken; generischer ERP/Shopify-Import

GET/api/v2/productsProdukte auflisten (filtern nach Status / Kategorie / Marke / Branche)

GET/api/v2/products/{id}Produkt mit Varianten, Medien und Inhalten erhalten

GET/api/v2/categoriesProduktkategorien auflisten

GET/api/v2/brandsMarken auflisten

POST/api/v2/catalog/importGenerische Aktualisierung – Marken/Kategorien/Produkte/Varianten/Lagerbestand von external_id

Mitglieder-Tags

4 EndpunktS

Lesen Sie den Tag-Katalog – Lebenszyklus, RFM, Wertstufe, Engagement, Kaufzeitpunkt, Präferenz (einschließlich Kategorieaffinität), Risiko, Einwilligung und Kanalachsen – und weisen Sie die Tags eines Mitglieds manuell zu bzw. entfernen Sie sie manuell

GET/api/v2/tagsListen-Tag-Definitionen (regelbasierte Achsen + boolean-Status-Tags)

GET/api/v2/members/{id}/tagsTags eines Mitglieds auflisten

POST/api/v2/members/{id}/tagsEinem Mitglied ein Tag zuweisen (über tagKey)

LÖSCHEN/api/v2/members/{id}/tags/{tagKey}Entfernen Sie die Kennzeichnung eines Mitglieds.

Benutzerdefinierte Felder

2 EndpunktS

Lesen Sie mandantendefinierte benutzerdefinierte Felder für jede Entität (Mitglied/Filiale/Produkt/Gutscheinpool/Bestellung). Schreibgeschützt; standardmäßig nicht personenbezogen. Bereich: custom_fields:read.

GET/api/v2/custom-fieldsBenutzerdefinierte Felddefinitionen für eine Entität auflisten (?entity=member|store|product|coupon_pool|order)

GET/api/v2/custom-fields/valuesAbrufen der benutzerdefinierten Feldwerte eines Datensatzes (?entity=…&entityId=…)

Aufnahmen

1 Endpunkt

Datensätze erfassen

GET/api/v2/capturesListen-Erfassungen

Gutscheine

4 EndpunktS

Gutscheincodes, Codes und Einlösung

GET/api/v2/couponsGutscheine auflisten

GET/api/v2/coupons/poolsCoupon-Pools auflisten

POST/api/v2/coupons/issueEinen Coupon ausstellen

POST/api/v2/coupons/{id}/redeemGutschein einlösen

Botschafter

3 EndpunktS

Botschafterprogramm – Kandidaten, ROI-Bericht und Partnercodes

GET/api/v2/ambassador/candidatesListe der Ambassador-Kandidaten

GET/api/v2/ambassador/metricsROI-Bericht für Ambassador anfordern

POST/api/v2/ambassador/members/{id}/issue-codeEinen Ambassador-Affiliate-Code ausgeben

Tracking

2 EndpunktS

Seitenaufruf-/Verhaltensanalyse und Ereigniserfassung

GET/api/v2/tracking/statsErhalten Sie Seitenbesuchs-/Verhaltensanalysen

POST/api/v2/tracking/eventsSeitenaufruf-/Tracking-Ereignis erfassen

API Schlüssel

3 EndpunktS

API Schlüsselverwaltung

GET/api/v2/api-keysAPI-Schlüssel auflisten

POST/api/v2/api-keysErstelle den Schlüssel API

LÖSCHEN/api/v2/api-keys/{id}Löschen Sie die Taste API.

Auth

7 EndpunktS

Authentifizierung und Benutzerprofil

POST/api/v2/auth/registerRegistrieren

POST/api/v2/auth/loginAnmelden

GET/api/v2/auth/profileProfil abrufen

PATCH/api/v2/auth/profileProfil aktualisieren

POST/api/v2/auth/change-passwordPasswort ändern

POST/api/v2/auth/forgot-passwordPasswort vergessen

POST/api/v2/auth/reset-passwordPasswort zurücksetzen

Segmente

5 EndpunktS

Zielgruppensegmente – Strukturierte Bedingungen für die Kampagnenausrichtung

GET/api/v2/segmentsZielgruppensegmente auflisten

POST/api/v2/segmentsSegment anhand strukturierter Bedingungen erstellen (nicht SQL)

GET/api/v2/segments/{id}Holen Sie sich ein Segment

PATCH/api/v2/segments/{id}Segment aktualisieren

LÖSCHEN/api/v2/segments/{id}Segment archivieren (weich)

Kampagnen

3 EndpunktS

Kampagnen – Listen erstellen und Entwürfe anfertigen (werden nie versendet; ein Mensch prüft und versendet sie).

GET/api/v2/campaignsListenkampagnen

POST/api/v2/campaignsErstellen Sie einen Kampagnenentwurf (wird nie versendet; aus einer Vorlage/Quelle)

GET/api/v2/campaigns/{id}Kampagne starten

Automatisierungen

2 EndpunktS

Automatisierungen – ereignisgesteuerte Abläufe auflisten und anhalten/fortsetzen

GET/api/v2/automationsAutomatisierungen und deren Status auflisten

PATCH/api/v2/automations/{id}Automatisierung pausieren oder fortsetzen

Transaktionsbasiert

1 Endpunkt

Transaktionsversand – Ihr System löst den Versand einer Kampagne an einen einzelnen Empfänger aus, die ein Benutzer explizit für die Transaktionsnutzung aktiviert hat (Bestellbestätigungen, Quittungen). API Inhalte werden niemals vom Autor bearbeitet; die Unterdrückung der Zustellbarkeit wird stets beachtet; weiter idempotency_key um Wiederholungsversuche sicher zu gestalten

POST/api/v2/transactional/sendEine aktivierte Kampagne mit zusammengeführten Daten an einen Empfänger senden

Importe

4 EndpunktS

Asynchroner Massenimport – Laden Sie eine CSV-/JSONL-Mitglieder-/Auftragsdatei hoch und rufen Sie den Job ab (keine Beschränkung auf 100 Zeilen).

POST/api/v2/members/importAsynchronen Mitgliederimport (CSV/JSON) in die Warteschlange stellen

GET/api/v2/members/import/{id}Status/Fortschritt von Importaufträgen für Mitglieder abfragen

POST/api/v2/orders/importAsynchronen Auftragsimport in die Warteschlange stellen (CSV/JSON)

GET/api/v2/orders/import/{id}Status/Fortschritt eines Importauftrags abfragen

Testdaten

1 Endpunkt

Sandbox-Testmodusdaten – alle mit einem Testschlüssel erstellten Daten werden gelöscht.

POST/api/v2/test-data/purgeAlle Testmodusdaten des Teams endgültig löschen

Kürzlich versendet

Prädiktive Profilfelder & intelligentere Empfehlungen

Zwei Upgrades werden in bestehende Endpunkte integriert – es gibt keine neue öffentliche Schnittstelle, und die Antwortstrukturen bestehender Empfehlungsendpunkte bleiben unverändert.

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

Die Profil-Rollups enthalten jetzt Vorhersagefelder, die berechnet werden, wenn die Daten des Teams eine Übereinstimmung unterstützen:

Erwartetes Datum der nächsten Bestellung – eine Gamma-Anpassung pro Mitglied an dessen individuellen Kaufintervallen (erfordert ≥ 3 Käufe), zurückgegeben mit Intervallstatistiken und einem Konfidenzindikator.
E-Mail-Klickwahrscheinlichkeit — eine pro Team L2-regularisierte Logistik P(click) aus den zusammenfassenden Engagement-Funktionen des Profils.

Beide Felder liegen null unterhalb der Integritätskriterien – niemals eine Vermutung. Verbraucher müssen null. bearbeiten.

Recommendations (public embed + v2)

Die Bewertung gemeinsamer Käufe wurde auf kosinusnormalisierte Artikelähnlichkeit aktualisiert, sodass die Paarstärke nicht mehr von Bestsellern dominiert wird:

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

Ein neuer, nächtlicher Job zur wird pro Team ausgeführt (Support/Confidence/Lift; MIN_PAIR_ORDERS=3, MIN_CONFIDENCE=0.05, Top 25 Regeln pro Antezedens nach Lift) und liefert Cross-Selling-Vorschläge. Bestehende Integrationen funktionieren weiterhin wie gewohnt – die Antwortmuster bleiben unverändert.

OpenAPI JSON (maschinenlesbar)Ausführen von Claude (SoCode)API-Schlüssel verwalten Zurück zu den Ressourcen