Sumber · Pembangun

REST API Rujukan

71 titik akhir merentasi sumber 19. SocialHub v2 REST API membolehkan anda mengurus kedai, ahli kesetiaan, mata, kupon, tangkapan, program Duta dan penjejakan. Semua titik akhir memerlukan Authorization: Bearer fl_live_… melainkan dinyatakan.

URL Asashttps://flash.socialhub.ai/api/v2

OpenAPI JSON Jalankan dari Claude (SoCode)

Rujukan ini mencerminkan API secara langsung. Ia merupakan gambaran statik katalog titik akhir, dikumpulkan mengikut sumber. Untuk kontrak yang sentiasa terkini dan boleh dibaca mesin (parameter, badan permintaan, skema respons), lihat OpenAPI JSON →

Pengesahan

Sahkan dengan kunci Bearer

Setiap permintaan disahkan dengan kunci SocialHub API (fl_live_…) yang dihantar sebagai token Bearer. Kunci diskopkan kepada pasukan anda dan setiap alat — cipta dan uruskan dalam akaun SocialHub anda.

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

Lebih suka menyimpan kunci teks biasa daripada sejarah cangkerang anda? Eksportnya sebagai FLASH_API_KEY dan rujuk var persekitaran.

Mod ujian (kotak pasir)

Tandakan kunci sebagai kunci ujian untuk dibina terhadap kotak pasir pada URL asas yang sama ini — tiada persekitaran atau kelayakan yang berasingan. Data yang ditulis dengannya (ahli, pesanan, kupon) ditag dan disembunyikan daripada senarai langsung dan papan pemuka anda; ahli ujian tidak pernah dihubungi sepenuhnya (e-mel pemasaran, SMS dan push disekat) dan kupon ujian tidak pernah ditebus dengan nilai sebenar; dan satu POST /api/v2/test-data/purge akan memadamkan semuanya. Bereksperimen secara bebas, kemudian tetapkan semula.

Urus API Kekunci

Rujukan

Titik Akhir

71 titik akhir merentasi kumpulan sumber 19. Kaedah, laluan dan ringkasan satu baris untuk setiap satu — parameter penuh dan butiran skema berada dalam OpenAPI JSON.

CWM Ramalan

4 titik akhirs

CWMpengagihan acara seterusnya terakhir tunggal, TimesFM 2.5 ramalan permintaan dan tetingkap gabungan penyewa-persendirian. Tingkah laku seterusnya memerlukan predictions:read; trend/tetingkap juga memerlukan metrics:readKebarangkalian peristiwa seterusnya tidak dikalibrasi dan bergantung pada sasaran yang disokong; tetingkap gabungan kekal null sehingga dilatih dan disahkan.

GET/api/v2/cwm/capabilitiesBaca ketersediaan trend/kuantil dan kesediaan gabungan penyewa 7/30/90 hari (predictions:read)

GET/api/v2/cwm/members/{id}/next-behaviorsRespons seorang ahli dengan pengedaran/kedudukan acara seterusnya dan automatik CWM + TimesFM 7/30/90d purchaseWindowsKebarangkalian peristiwa tidak dikalibrasi; tetingkap pembelian null sehingga dilatih/disahkan (predictions:read; metrics:read tambahan pula membolehkan tetingkap)

GET/api/v2/cwm/trendsRamalan metrik jenama/kategori harian: titik + q10..q90 tidak ditentukur; hari yang hilang tetap tidak tersedia

GET/api/v2/cwm/members/{id}/purchase-windowsKebarangkalian pembelian penyewa-persendirian 7/30/90 hari (0–1), null sehingga dilatih dan disahkan

Kedai

4 titik akhirs

Pengurusan kedai

GET/api/v2/storesSenaraikan kedai (tapis mengikut externalId / updatedSince)

GET/api/v2/stores/{id}Dapatkan kedai dengan ID

POST/api/v2/storesCipta atau naik taraf kedai (oleh externalId)

PUT/api/v2/stores/{id}Kemas kini kedai

Ahli

12 titik akhirs

Pengurusan ahli kesetiaan

GET/api/v2/membersSenarai / cari ahli (e-mel, externalId, updatedSince)

POST/api/v2/membersCipta atau tambah ahli (melalui externalId / e-mel)

POST/api/v2/members/batchCipta/tambah ahli secara pukal (≤100, 207)

GET/api/v2/members/{id}Dapatkan ahli melalui ID

TAMPALAN/api/v2/members/{id}Kemas kini profil / identiti ahli

GET/api/v2/members/{id}/pointsDapatkan baki mata ahli

POST/api/v2/members/{id}/pointsDapatkan / tebus / balikkan mata

GET/api/v2/members/{id}/tierDapatkan peringkat ahli

GET/api/v2/members/{id}/couponsDapatkan kupon ahli

GET/api/v2/members/{id}/receiptsDapatkan resit ahli

GET/api/v2/members/{id}/profileDapatkan profil agregat ahli — kebolehcapaian, persetujuan/CCPA, kesetiaan, gulungan perdagangan/penglibatan + medan ramalan (tarikh pesanan seterusnya yang dijangkakan, kecenderungan klik e-mel; null di bawah get data), pilihan, tag (baca sahaja, disunting PII)

POST/api/v2/members/{id}/redeem-couponTebus mata untuk kupon

Pesanan

4 titik akhirs

Pengemasan pesanan → mata pemberian automatik, bayaran balik dan penyelarasan

GET/api/v2/ordersSenaraikan pesanan yang diserap (tapis mengikut ahli / externalId / updatedSince)

POST/api/v2/ordersMengambil pesanan dan menganugerahkan mata secara automatik

POST/api/v2/orders/batchPengekalan pesanan pukal (≤100, 207)

POST/api/v2/orders/{externalOrderId}/refundBayar balik pesanan (mata berkadaran claw-back)

Katalog

5 titik akhirs

Katalog produk (PIM) — produk, varian, kategori, jenama; ERP generik/Shopify import

GET/api/v2/productsSenaraikan produk (tapis mengikut status / kategori / jenama / vertikal)

GET/api/v2/products/{id}Dapatkan produk dengan varian, media dan kandungan

GET/api/v2/categoriesSenaraikan kategori produk

GET/api/v2/brandsSenaraikan jenama

POST/api/v2/catalog/importPenyerapan generik — jenama/kategori/produk/varian/inventori oleh external_id

Tag Ahli

4 titik akhirs

Baca katalog tag — kitaran hayat, RFM, peringkat nilai, penglibatan, masa pembelian, keutamaan (termasuk afiniti kategori), risiko, persetujuan dan paksi saluran — dan tetapkan/alih keluar tag ahli secara manual

GET/api/v2/tagsTakrif tag senarai (paksi dipacu peraturan + tag negeri boolean)

GET/api/v2/members/{id}/tagsSenaraikan tag ahli

POST/api/v2/members/{id}/tagsTetapkan tag kepada ahli (mengikut tagKey)

PADAM/api/v2/members/{id}/tags/{tagKey}Alih keluar tag ahli

Medan Tersuai

2 titik akhirs

Baca medan tersuai yang ditakrifkan oleh penyewa untuk mana-mana entiti (ahli / kedai / produk / kumpulan kupon / pesanan). Baca sahaja; bukan PII oleh reka bentuk. Skop: custom_fields:baca.

GET/api/v2/custom-fieldsSenaraikan definisi medan tersuai untuk entiti (?entity=member|store|product|coupon_pool|order)

GET/api/v2/custom-fields/valuesDapatkan nilai medan tersuai rekod (?entity=…&entityId=…)

Tangkapan

1 titik akhir

Tangkap rekod

GET/api/v2/capturesRakaman senarai

Kupon

4 titik akhirs

Kumpulan kupon, kod dan penebusan

GET/api/v2/couponsSenaraikan kupon

GET/api/v2/coupons/poolsSenaraikan kumpulan kupon

POST/api/v2/coupons/issueKeluarkan kupon

POST/api/v2/coupons/{id}/redeemTebus kupon

Duta

3 titik akhirs

Program Duta — calon, laporan ROI dan kod afiliasi

GET/api/v2/ambassador/candidatesSenaraikan calon Duta

GET/api/v2/ambassador/metricsDapatkan laporan ROI Duta

POST/api/v2/ambassador/members/{id}/issue-codeKeluarkan kod afiliasi Duta

Penjejakan

2 titik akhirs

Analisis lawatan halaman / tingkah laku dan pengambilan peristiwa

GET/api/v2/tracking/statsDapatkan analitik lawatan halaman / tingkah laku

POST/api/v2/tracking/eventsMencerna peristiwa paparan halaman / penjejakan

API Kekunci

3 titik akhirs

API pengurusan kunci

GET/api/v2/api-keysSenaraikan kekunci API

POST/api/v2/api-keysCipta kunci API

PADAM/api/v2/api-keys/{id}Padam kunci API

Pengesahan

7 titik akhirs

Pengesahan dan profil pengguna

POST/api/v2/auth/registerDaftar

POST/api/v2/auth/loginLog masuk

GET/api/v2/auth/profileDapatkan profil

TAMPALAN/api/v2/auth/profileKemas kini profil

POST/api/v2/auth/change-passwordTukar kata laluan

POST/api/v2/auth/forgot-passwordLupa kata laluan

POST/api/v2/auth/reset-passwordTetapkan semula kata laluan

Segmen

5 titik akhirs

Segmen khalayak — keadaan berstruktur yang digunakan untuk menyasarkan kempen

GET/api/v2/segmentsSenaraikan segmen khalayak

POST/api/v2/segmentsCipta segmen daripada keadaan berstruktur (bukan SQL)

GET/api/v2/segments/{id}Dapatkan segmen

TAMPALAN/api/v2/segments/{id}Kemas kini segmen

PADAM/api/v2/segments/{id}Arkibkan segmen (lembut)

Kempen

3 titik akhirs

Kempen — senaraikan dan cipta draf (tidak pernah dihantar; manusia menyemak dan menghantar)

GET/api/v2/campaignsSenaraikan kempen

POST/api/v2/campaignsCipta DRAF kempen (tidak pernah dihantar; daripada templat/sumber)

GET/api/v2/campaigns/{id}Dapatkan kempen

Automasi

2 titik akhirs

Automasi — senaraikan aliran yang dicetuskan oleh peristiwa dan jeda/sambung semula

GET/api/v2/automationsSenaraikan automasi dan statusnya

TAMPALAN/api/v2/automations/{id}Jeda atau sambung semula automasi

Transaksi

1 titik akhir

Penghantaran transaksi — sistem anda mencetuskan penghantaran penerima tunggal kempen yang didayakan oleh manusia secara eksplisit untuk kegunaan transaksi (pengesahan pesanan, resit). API tidak pernah mengarang kandungan; penindasan kebolehhantaran sentiasa dihormati; lulus idempotency_key untuk memastikan percubaan semula selamat

POST/api/v2/transactional/sendHantar kempen yang didayakan kepada seorang penerima dengan data gabungan

Import

4 titik akhirs

Import pukal async — muat naik fail ahli/pesanan CSV/JSONL dan undi kerja (tiada had 100 baris)

POST/api/v2/members/importBerbaris untuk import ahli async (CSV/JSONL)

GET/api/v2/members/import/{id}Tinjau status/kemajuan kerja import ahli

POST/api/v2/orders/importBerbaris import pesanan tak segerak (CSV/JSONL)

GET/api/v2/orders/import/{id}Tinjau status/kemajuan kerja import pesanan

Data ujian

1 titik akhir

Data mod ujian kotak pasir — bersihkan semua yang dibuat oleh kunci ujian

POST/api/v2/test-data/purgePadam keras semua data mod ujian pasukan

Baru dihantar

Medan profil ramalan & cadangan yang lebih pintar

Dua peningkatan berada di dalam titik akhir sedia ada — tiada permukaan awam baharu, dan bentuk tindak balas titik akhir cadangan sedia ada tidak berubah.

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

Penggulungan profil kini merangkumi medan ramalan, yang dikira apabila data pasukan menyokong kesesuaian:

Tarikh pesanan seterusnya yang dijangkakan — padanan Gamma setiap ahli pada selang pembelian ahli sendiri (memerlukan ≥ 3 pembelian), dikembalikan dengan statistik selang dan penunjuk keyakinan.
Kecenderungan klik e-mel — logistik L2-regular setiap pasukan P(click) daripada ciri penglibatan rollup profil.

Kedua-dua medan berada null di bawah pintu kejujuran — bukan tekaan. Pengguna mesti mengendalikan null.

Recommendations (public embed + v2)

Pemarkahan pembelian bersama dinaik taraf kepada kesamaan item-item yang dinormalisasi kosinus, jadi kekuatan pasangan tidak lagi dikuasai oleh penjual terlaris:

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

Larian kerja setiap malam yang baharu bagi setiap pasukan (sokongan / keyakinan / peningkatan; MIN_PAIR_ORDERS=3, MIN_CONFIDENCE=0.05, 25 peraturan teratas bagi setiap anteseden mengikut peningkatan) dan memberi cadangan jualan silang. Integrasi sedia ada terus berfungsi seperti sedia ada — bentuk respons tidak berubah.

OpenAPI JSON (boleh dibaca mesin)Jalankan dari Claude (SoCode)Urus API Kekunci Kembali ke Sumber