Sumber Daya · Pengembang

REST API Referensi

71 titik akhir di seluruh sumber daya 19. SocialHub v2 REST API memungkinkan Anda mengelola toko, anggota loyalitas, poin, kupon, tangkapan, program Duta Besar, dan pelacakan. Semua endpoint memerlukan Authorization: Bearer fl_live_… kecuali dinyatakan lain.

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

OpenAPI JSON Berjalan dari Claude (SoCode)

Referensi ini mencerminkan API yang aktif. Ini adalah cuplikan statis dari katalog titik akhir, dikelompokkan berdasarkan sumber daya. Untuk kontrak yang selalu terkini dan dapat dibaca mesin (parameter, isi permintaan, skema respons), lihat OpenAPI JSON →

Otentikasi

Otentikasi dengan kunci Bearer

Setiap permintaan diautentikasi dengan kunci SocialHub API (fl_live_…) yang dikirim sebagai token Bearer. Kunci dibatasi untuk tim Anda dan per alat — buat dan kelola di akun SocialHub Anda.

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

Lebih suka menyimpan kunci teks biasa di luar riwayat shell Anda? Ekspor sebagai FLASH_API_KEY dan referensikan variabel lingkungan.

Mode uji (sandbox)

Tandai kunci sebagai kunci uji untuk membangun di lingkungan uji (sandbox) pada URL dasar yang sama — tanpa lingkungan atau kredensial terpisah. Data yang ditulis dengannya (anggota, pesanan, kupon) diberi tag dan disembunyikan dari daftar dan dasbor langsung Anda; anggota uji tidak pernah benar-benar dihubungi (email pemasaran, SMS, dan pemberitahuan push ditekan) dan kupon uji tidak pernah ditukarkan dengan nilai sebenarnya; dan satu POST /api/v2/test-data/purge akan menghapus semuanya. Bereksperimenlah dengan bebas, lalu atur ulang.

Kelola Kunci API

Referensi

Titik akhir

Titik akhir 71 di seluruh grup sumber daya 19. Metode, jalur, dan ringkasan satu baris untuk masing-masing — detail parameter dan skema lengkap terdapat dalam OpenAPI JSON.

CWM Prakiraan

4 titik akhirs

CWMdistribusi kejadian selanjutnya tunggal terakhirnya, TimesFM 2.5 perkiraan permintaan dan jendela fusi penyewa-pribadi. Perilaku selanjutnya membutuhkan predictions:read; tren/jendela juga membutuhkan metrics:readProbabilitas kejadian berikutnya tidak dikalibrasi dan bergantung pada target yang didukung; jendela fusi tetap ada. null sampai terlatih dan tervalidasi.

GET/api/v2/cwm/capabilitiesBaca ketersediaan tren/kuantil dan kesiapan fusi penyewa 7/30/90 hari (predictions:read)

GET/api/v2/cwm/members/{id}/next-behaviorsSatu tanggapan anggota dengan distribusi/peringkat acara berikutnya dan otomatis. CWM + TimesFM 7/30/90d purchaseWindowsProbabilitas kejadian tidak terkalibrasi; jendela pembelian null sampai terlatih/tervalidasi (predictions:read; metrics:read (juga memungkinkan jendela)

GET/api/v2/cwm/trendsPerkiraan metrik merek/kategori harian: poin + q10..q90 yang tidak dikalibrasi; hari yang hilang tetap tidak tersedia

GET/api/v2/cwm/members/{id}/purchase-windowsProbabilitas pembelian tenant-private 7/30/90d (0–1), null hingga dilatih dan divalidasi

Toko

4 titik akhirs

Manajemen Toko

GET/api/v2/storesDaftar toko (filter berdasarkan externalId / updatedSince)

GET/api/v2/stores/{id}Dapatkan toko berdasarkan ID

POST/api/v2/storesBuat atau perbarui toko (berdasarkan externalId)

PUT/api/v2/stores/{id}Perbarui toko

Anggota

12 titik akhirs

Manajemen anggota loyalitas

GET/api/v2/membersDaftar / cari anggota (email, externalId, updatedSince)

POST/api/v2/membersBuat atau tambahkan anggota (berdasarkan externalId / email)

POST/api/v2/members/batchPembuatan/penyisipan anggota secara massal (≤100, 207)

GET/api/v2/members/{id}Dapatkan anggota berdasarkan ID

PATCH/api/v2/members/{id}Perbarui profil/identitas anggota

GET/api/v2/members/{id}/pointsDapatkan saldo poin anggota

POST/api/v2/members/{id}/pointsDapatkan / tukarkan / balikkan poin

GET/api/v2/members/{id}/tierDapatkan tingkatan keanggotaan

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

GET/api/v2/members/{id}/receiptsDapatkan tanda terima anggota

GET/api/v2/members/{id}/profileDapatkan profil gabungan anggota — jangkauan, persetujuan/CCPA, loyalitas, penggabungan perdagangan/keterlibatan + bidang prediktif (tanggal pesanan berikutnya yang diharapkan, kecenderungan klik email; null di bawah gerbang data), preferensi, tag (hanya baca, PII disunting)

POST/api/v2/members/{id}/redeem-couponTukarkan poin untuk kupon

Pesanan

4 titik akhirs

Penerapan pesanan → pemberian poin otomatis, pengembalian dana, dan rekonsiliasi

GET/api/v2/ordersDaftar pesanan yang masuk (filter berdasarkan anggota / externalId / updatedSince)

POST/api/v2/ordersMasukkan pesanan dan berikan poin secara otomatis

POST/api/v2/orders/batchPengambilan pesanan massal (≤100, 207)

POST/api/v2/orders/{externalOrderId}/refundPengembalian dana pesanan (pengembalian poin proporsional)

Katalog

5 titik akhirs

Katalog produk (PIM) — produk, varian, kategori, merek; Impor ERP generik/Shopify

GET/api/v2/productsDaftar produk (filter berdasarkan status / kategori / merek / vertikal)

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

GET/api/v2/categoriesDaftar kategori produk

GET/api/v2/brandsDaftar merek

POST/api/v2/catalog/importUpsert generik — merek/kategori/produk/varian/inventaris berdasarkan external_id

Tag Anggota

4 titik akhirs

Baca katalog tag — siklus hidup, RFM, tingkatan nilai, keterlibatan, waktu pembelian, preferensi (termasuk afinitas kategori), risiko, persetujuan, dan sumbu saluran — dan tetapkan/hapus tag anggota secara manual.

GET/api/v2/tagsDefinisi tag daftar (sumbu berbasis aturan + tag status boolean)

GET/api/v2/members/{id}/tagsMencantumkan tag anggota

POST/api/v2/members/{id}/tagsTetapkan tag ke anggota (berdasarkan tagKey)

HAPUS/api/v2/members/{id}/tags/{tagKey}Hapus tag anggota

Bidang Kustom

2 titik akhirs

Baca bidang kustom yang ditentukan penyewa untuk entitas apa pun (anggota / toko / produk / kumpulan kupon / pesanan). Hanya baca; bukan PII berdasarkan desain. Cakupan: custom_fields:read.

GET/api/v2/custom-fieldsDaftar definisi bidang kustom untuk suatu entitas (?entity=member|store|product|coupon_pool|order)

GET/api/v2/custom-fields/valuesDapatkan nilai bidang kustom suatu catatan (?entity=…&entityId=…)

Pengambilan data

1 titik akhir

Rekaman tangkapan

GET/api/v2/capturesDaftar tangkapan layar

Kupon

4 titik akhirs

Kumpulan kupon, kode, dan penukaran

GET/api/v2/couponsDaftar kupon

GET/api/v2/coupons/poolsDaftar kumpulan kupon

POST/api/v2/coupons/issueTerbitkan kupon

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

Duta Besar

3 titik akhirs

Program Duta — kandidat, laporan ROI, dan kode afiliasi

GET/api/v2/ambassador/candidatesDaftar kandidat Duta

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

POST/api/v2/ambassador/members/{id}/issue-codeTerbitkan kode afiliasi Duta Besar

Pelacakan

2 titik akhirs

Analisis kunjungan halaman/perilaku dan penyerapan peristiwa

GET/api/v2/tracking/statsDapatkan analitik kunjungan halaman/perilaku

POST/api/v2/tracking/eventsMengumpulkan data kunjungan halaman/pelacakan

API Kunci

3 titik akhirs

API manajemen kunci

GET/api/v2/api-keysDaftar kunci API

POST/api/v2/api-keysBuat kunci API

HAPUS/api/v2/api-keys/{id}Hapus kunci API

Otorisasi

7 titik akhirs

Autentikasi dan profil pengguna

POST/api/v2/auth/registerDaftar

POST/api/v2/auth/loginMasuk

GET/api/v2/auth/profileDapatkan profil

PATCH/api/v2/auth/profilePerbarui profil

POST/api/v2/auth/change-passwordUbah kata sandi

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

POST/api/v2/auth/reset-passwordReset kata sandi

Segmen

5 titik akhirs

Segmen audiens — kondisi terstruktur yang digunakan untuk menargetkan kampanye

GET/api/v2/segmentsDaftar segmen audiens

POST/api/v2/segmentsBuat segmen dari kondisi terstruktur (bukan SQL)

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

PATCH/api/v2/segments/{id}Perbarui segmen

HAPUS/api/v2/segments/{id}Arsipkan segmen (lunak)

Kampanye

3 titik akhirs

Kampanye — daftar dan buat draf (tidak pernah dikirim; manusia meninjau dan mengirim)

GET/api/v2/campaignsDaftar kampanye

POST/api/v2/campaignsBuat DRAFT kampanye (tidak pernah terkirim; dari templat/sumber)

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

Otomatisasi

2 titik akhirs

Otomatisasi — daftar alur yang dipicu oleh peristiwa dan jeda/lanjutkan

GET/api/v2/automationsDaftar otomatisasi dan statusnya

PATCH/api/v2/automations/{id}Jeda atau lanjutkan otomatisasi

Transaksi

1 titik akhir

Pengiriman transaksional — sistem Anda memicu pengiriman kampanye ke satu penerima yang secara eksplisit diaktifkan oleh manusia untuk penggunaan transaksional (konfirmasi pesanan, tanda terima). API tidak pernah membuat konten; penekanan pengiriman selalu dihormati; Lewatkan idempotency_key untuk membuat percobaan ulang aman

POST/api/v2/transactional/sendKirim kampanye yang diaktifkan ke satu penerima dengan data gabungan

Impor

4 titik akhirs

Impor massal asinkron — unggah file anggota/pesanan CSV/JSONL dan lakukan polling pada pekerjaan (tidak ada batasan 100 baris)

POST/api/v2/members/importAntrekan impor anggota asinkron (CSV/JSONL)

GET/api/v2/members/import/{id}Polling status/kemajuan pekerjaan impor anggota

POST/api/v2/orders/importAntrekan impor pesanan asinkron (CSV/JSONL)

GET/api/v2/orders/import/{id}Polling status/progress pekerjaan impor pesanan

Data uji

1 titik akhir

Data mode uji Sandbox — hapus semua yang dibuat oleh kunci uji

POST/api/v2/test-data/purgeHapus total semua data mode uji tim

Baru saja dikirim

Bidang profil prediktif & rekomendasi yang lebih cerdas

Dua peningkatan diterapkan di dalam endpoint yang sudah ada — tidak ada permukaan publik baru, dan bentuk respons dari endpoint rekomendasi yang sudah ada tidak berubah.

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

Ringkasan profil sekarang mencakup kolom prediktif, yang dihitung ketika data tim mendukung kecocokan:

Tanggal pesanan berikutnya yang diharapkan — kecocokan Gamma per anggota pada interval pembelian anggota sendiri (membutuhkan ≥ 3 pembelian), dikembalikan dengan statistik interval dan indikator kepercayaan.
Kecenderungan klik email — logistik P(click) yang diatur L2 per tim dari fitur keterlibatan rollup profil.

Kedua bidang tersebut adalah null di bawah gerbang kejujuran — bukan tebakan. Konsumen harus menangani null.

Recommendations (public embed + v2)

Penilaian pembelian bersama ditingkatkan menjadi kesamaan item-item yang dinormalisasi kosinus, sehingga kekuatan pasangan tidak lagi didominasi oleh produk terlaris:

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

Tayangan malam baru Tugas dijalankan per tim (dukungan / kepercayaan diri / peningkatan kemampuan); MIN_PAIR_ORDERS=3, MIN_CONFIDENCE=0.05(25 aturan teratas per anteseden berdasarkan lift) dan memberikan saran penjualan silang. Integrasi yang ada tetap berfungsi seperti biasa — bentuk respons tidak berubah.

OpenAPI JSON (dapat dibaca mesin)Berjalan dari Claude (SoCode)Kelola Kunci API Kembali ke Sumber Daya