SocialHub.AI
แหล่งข้อมูล · นักพัฒนา

REST API ข้อมูลอ้างอิง

71 ปลายทางทั่วทั้งทรัพยากร 19 SocialHub v2 REST API ช่วยให้คุณจัดการร้านค้า สมาชิกสะสมคะแนน คูปอง แคปเจอร์ โปรแกรม Ambassador และการติดตาม ตำแหน่งข้อมูลทั้งหมดต้องมี Authorization: Bearer fl_live_… เว้นแต่จะระบุไว้

URL พื้นฐานhttps://flash.socialhub.ai/api/v2

ข้อมูลอ้างอิงนี้สะท้อนถึงข้อมูลจริง API เป็นภาพนิ่งของแคตตาล็อกปลายทางที่จัดกลุ่มตามทรัพยากร สำหรับสัญญาที่เครื่องอ่านได้และอัปเดตอยู่เสมอ (พารามิเตอร์ เนื้อหาคำขอ โครงสร้างการตอบกลับ) โปรดดูที่ OpenAPI JSON →

การตรวจสอบสิทธิ์

ตรวจสอบสิทธิ์ด้วยคีย์ Bearer

ทุกคำขอจะได้รับการตรวจสอบสิทธิ์ด้วยคีย์ SocialHub API (fl_live_…) ที่ส่งเป็นโทเค็น Bearer คีย์เหล่านี้มีขอบเขตเฉพาะสำหรับทีมของคุณและต่อเครื่องมือ — สร้างและจัดการคีย์เหล่านี้ในบัญชี SocialHub ของคุณ

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

ต้องการเก็บคีย์ข้อความธรรมดาออกจากประวัติเชลล์ของคุณหรือไม่? ส่งออกเป็น FLASH_API_KEY และอ้างอิง env var

โหมดทดสอบ (แซนด์บ็อกซ์)

กำหนดคีย์เป็น คีย์ทดสอบ เพื่อสร้างแอปพลิเคชันในสภาพแวดล้อมจำลอง (sandbox) บน URL เดียวกันนี้ โดยไม่ต้องใช้สภาพแวดล้อมหรือข้อมูลรับรองแยกต่างหาก ข้อมูลที่เขียนด้วยคีย์นี้ (สมาชิก คำสั่งซื้อ คูปอง) จะถูกติดแท็กและซ่อนจากรายการและแดชบอร์ดที่ใช้งานจริงของคุณ สมาชิกทดสอบจะไม่ได้รับการติดต่อจริง ๆ (อีเมลการตลาด SMS และการแจ้งเตือนแบบพุชจะถูกระงับ) และคูปองทดสอบจะไม่สามารถแลกเป็นมูลค่าจริงได้ และการแก้ไข POST /api/v2/test-data/purge เพียงครั้งเดียวจะลบข้อมูลทั้งหมด ทดลองได้อย่างอิสระ แล้วรีเซ็ต

อ้างอิง

เอนด์พอยต์

ปลายทาง 71 ทั่วทั้งกลุ่มทรัพยากร 19 วิธีการ เส้นทาง และการสรุปหนึ่งบรรทัดสำหรับแต่ละพารามิเตอร์ — พารามิเตอร์แบบเต็มและรายละเอียดสคีมาอาศัยอยู่ใน OpenAPI JSON

CWM การคาดการณ์

4 ปลายทาง s

CWMการแจกจ่ายเหตุการณ์ถัดไปครั้งสุดท้ายเพียงครั้งเดียวของ TimesFM 2.5 การคาดการณ์ความต้องการและหน้าต่างการรวมส่วนตัวของผู้เช่า พฤติกรรมถัดไปต้องการ predictions:readแนวโน้ม/หน้าต่างยังต้องการ metrics:readความน่าจะเป็นของเหตุการณ์ถัดไปไม่ได้ถูกปรับเทียบและขึ้นอยู่กับเป้าหมายที่รองรับ หน้าต่างการรวมข้อมูลยังคงอยู่ null จนกว่าจะได้รับการฝึกอบรมและตรวจสอบความถูกต้อง

GET/api/v2/cwm/capabilities
GET/api/v2/cwm/members/{id}/next-behaviors
GET/api/v2/cwm/trends
GET/api/v2/cwm/members/{id}/purchase-windows

ร้านค้า

4 ปลายทาง s

การจัดการร้านค้า

GET/api/v2/stores
GET/api/v2/stores/{id}
POST/api/v2/stores
PUT/api/v2/stores/{id}

สมาชิก

12 ปลายทาง s

การจัดการสมาชิกความภักดี

GET/api/v2/members
POST/api/v2/members
POST/api/v2/members/batch
GET/api/v2/members/{id}
แพทช์/api/v2/members/{id}
GET/api/v2/members/{id}/points
POST/api/v2/members/{id}/points
GET/api/v2/members/{id}/tier
GET/api/v2/members/{id}/coupons
GET/api/v2/members/{id}/receipts
GET/api/v2/members/{id}/profile
POST/api/v2/members/{id}/redeem-coupon

คำสั่งซื้อ

4 ปลายทาง s

การนำเข้าคำสั่งซื้อ → ให้คะแนนอัตโนมัติ การคืนเงิน และการปรับยอด

GET/api/v2/orders
POST/api/v2/orders
POST/api/v2/orders/batch
POST/api/v2/orders/{externalOrderId}/refund

แคตตาล็อก

5 ปลายทาง s

แคตตาล็อกผลิตภัณฑ์ (PIM) — ผลิตภัณฑ์ ตัวเลือก หมวดหมู่ แบรนด์; นำเข้า ERP ทั่วไป/Shopify

GET/api/v2/products
GET/api/v2/products/{id}
GET/api/v2/categories
GET/api/v2/brands
POST/api/v2/catalog/import

แท็กสมาชิก

4 ปลายทาง s

อ่านแค็ตตาล็อกแท็ก — วงจรชีวิต, RFM, ระดับมูลค่า, การมีส่วนร่วม, ระยะเวลาในการซื้อ, การกำหนดลักษณะ (รวมถึงความเกี่ยวข้องของหมวดหมู่), ความเสี่ยง, ความยินยอม และแกนของช่องทาง — และกำหนด/ลบแท็กของสมาชิกด้วยตนเอง

GET/api/v2/tags
GET/api/v2/members/{id}/tags
POST/api/v2/members/{id}/tags
ลบ/api/v2/members/{id}/tags/{tagKey}

ฟิลด์ที่กำหนดเอง

2 ปลายทาง s

อ่านฟิลด์ที่กำหนดเองโดยผู้เช่าสำหรับเอนทิตีใดๆ (สมาชิก / ร้านค้า / ผลิตภัณฑ์ / กลุ่มคูปอง / คำสั่งซื้อ) อ่านอย่างเดียว ไม่ใช่ข้อมูลส่วนบุคคลตามการออกแบบ ขอบเขต: custom_fields:read

GET/api/v2/custom-fields
GET/api/v2/custom-fields/values

จับภาพ

1 ปลายทาง

บันทึกข้อมูล

GET/api/v2/captures

คูปอง

4 ปลายทาง s

กลุ่มคูปอง รหัส และการแลกของรางวัล

GET/api/v2/coupons
GET/api/v2/coupons/pools
POST/api/v2/coupons/issue
POST/api/v2/coupons/{id}/redeem

เอกอัครราชทูต

3 ปลายทาง s

โปรแกรม Ambassador — ผู้สมัคร รายงาน ROI และรหัสพันธมิตร

GET/api/v2/ambassador/candidates
GET/api/v2/ambassador/metrics
POST/api/v2/ambassador/members/{id}/issue-code

การติดตาม

2 ปลายทาง s

การวิเคราะห์การเข้าชมเพจ/พฤติกรรม และการบันทึกเหตุการณ์

GET/api/v2/tracking/stats
POST/api/v2/tracking/events

API คีย์

3 ปลายทาง s

API การจัดการคีย์

GET/api/v2/api-keys
POST/api/v2/api-keys
ลบ/api/v2/api-keys/{id}

การรับรองความถูกต้อง

7 ปลายทาง s

การตรวจสอบสิทธิ์และโปรไฟล์ผู้ใช้

POST/api/v2/auth/register
POST/api/v2/auth/login
GET/api/v2/auth/profile
แพทช์/api/v2/auth/profile
POST/api/v2/auth/change-password
POST/api/v2/auth/forgot-password
POST/api/v2/auth/reset-password

ส่วนต่างๆ

5 ปลายทาง s

กลุ่มผู้ชม — เงื่อนไขที่มีโครงสร้างที่ใช้ในการกำหนดเป้าหมายแคมเปญ

GET/api/v2/segments
POST/api/v2/segments
GET/api/v2/segments/{id}
แพทช์/api/v2/segments/{id}
ลบ/api/v2/segments/{id}

แคมเปญ

3 ปลายทาง s

แคมเปญ — แสดงรายการและสร้างแบบร่าง (ไม่ต้องส่ง; ให้มนุษย์ตรวจสอบและส่ง)

GET/api/v2/campaigns
POST/api/v2/campaigns
GET/api/v2/campaigns/{id}

ระบบอัตโนมัติ

2 ปลายทาง s

ระบบอัตโนมัติ — แสดงรายการโฟลว์ที่กระตุ้นโดยเหตุการณ์และหยุดชั่วคราว/ดำเนินการต่อ

GET/api/v2/automations
แพทช์/api/v2/automations/{id}

การทำธุรกรรม

1 ปลายทาง

การส่งตามธุรกรรม — ระบบของคุณทริกเกอร์การส่งแคมเปญที่มีผู้รับเพียงรายเดียวซึ่งเปิดใช้งานโดยมนุษย์อย่างชัดเจนสำหรับการใช้งานในธุรกรรม (การยืนยันคำสั่งซื้อ ใบเสร็จรับเงิน) API ไม่เคยเขียนเนื้อหา การปราบปรามการส่งมอบนั้นได้รับเกียรติเสมอ ส่งผ่าน idempotency_key เพื่อให้การลองใหม่ปลอดภัย

POST/api/v2/transactional/send

การนำเข้า

4 ปลายทาง s

การนำเข้าจำนวนมากแบบ Async — อัปโหลดไฟล์สมาชิก CSV/JSONL/คำสั่งซื้อ และสำรวจงาน (ไม่จำกัดแถวสูงสุด 100 แถว)

POST/api/v2/members/import
GET/api/v2/members/import/{id}
POST/api/v2/orders/import
GET/api/v2/orders/import/{id}

ข้อมูลทดสอบ

1 ปลายทาง

ข้อมูลโหมดทดสอบแซนด์บ็อกซ์ — ล้างข้อมูลทุกอย่างที่สร้างคีย์ทดสอบ

POST/api/v2/test-data/purge
เพิ่งส่งไป

ช่องโปรไฟล์การคาดการณ์และคำแนะนำที่ชาญฉลาดยิ่งขึ้น

การอัปเกรดสองครั้งจะเข้าสู่ตำแหน่งข้อมูลที่มีอยู่ — ไม่มีพื้นผิวสาธารณะใหม่และรูปแบบการตอบสนองของตำแหน่งข้อมูลคำแนะนำที่มีอยู่ไม่เปลี่ยนแปลง

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

การรวบรวมโปรไฟล์ตอนนี้รวม ฟิลด์การคาดการณ์ ซึ่งคำนวณเมื่อข้อมูลของทีมรองรับ:

  • วันที่คาดว่าจะสั่งซื้อครั้งถัดไป — การปรับแบบ Gamma ต่อสมาชิกตามช่วงเวลาการซื้อของสมาชิกเอง (ต้องมีการซื้ออย่างน้อย 3 ครั้ง) โดยจะส่งคืนพร้อมสถิติช่วงเวลาและตัวบ่งชี้ความเชื่อมั่น
  • ความน่าจะเป็นในการคลิกอีเมล — โลจิสติกส์ที่ปรับค่า L2 ต่อทีม P(click) จากคุณสมบัติการมีส่วนร่วมแบบรวมของโปรไฟล์

ทั้งสองฟิลด์ 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 อันดับแรกต่อรายการก่อนหน้าตามการเพิ่ม) และฟีดคำแนะนำการขายต่อเนื่อง การผสานรวมที่มีอยู่จะยังคงทำงานเหมือนเดิม รูปร่างการตอบสนองไม่เปลี่ยนแปลง