SocialHub.AI
리소스 · 개발자

REST API 참고 자료

19 리소스 전체의 71 엔드포인트. SocialHub v2 REST API를 사용하면 매장, 충성도 회원, 포인트, 쿠폰, 캡처, 앰배서더 프로그램 및 추적을 관리할 수 있습니다. 별도의 언급이 없는 한 모든 엔드포인트에는 Authorization: Bearer fl_live_…가 필요합니다.

기본 URLhttps://flash.socialhub.ai/api/v2

이 참조는 실제 API를 반영합니다. 리소스별로 그룹화된 엔드포인트 카탈로그의 정적 스냅샷입니다. 항상 최신 상태로 유지되는 기계 판독 가능한 계약(매개변수, 요청 본문, 응답 스키마)은 OpenAPI JSON →을 참조하세요.

인증

베어러 키로 인증

모든 요청은 Bearer 토큰으로 전송되는 SocialHub API 키(fl_live_…)를 사용하여 인증됩니다. 키는 팀 및 도구별로 범위가 지정되며, SocialHub 계정에서 생성하고 관리할 수 있습니다.

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

셸 기록에 평문 키를 남기지 않으려면 FLASH_API_KEY으로 내보내고 환경 변수를 참조하세요.

테스트 모드(샌드박스)

키를 테스트 키로 표시하면 동일한 기본 URL의 샌드박스 환경에서 빌드할 수 있습니다. 별도의 환경이나 자격 증명이 필요하지 않습니다. 해당 키로 작성된 데이터(회원, 주문, 쿠폰)는 태그가 지정되어 실제 목록 및 대시보드에서 숨겨집니다. 테스트 회원에게는 마케팅 이메일, SMS, 푸시 알림이 발송되지 않으며, 테스트 쿠폰은 실제 사용 시 효력이 없습니다. 또한, POST /api/v2/test-data/purge 키를 한 번만 누르면 모든 데이터가 삭제됩니다. 자유롭게 테스트하고, 테스트 후에는 초기화하세요.

참고 자료

엔드포인트

19 리소스 그룹 전체의 71 엔드포인트. 각 엔드포인트에 대한 메서드, 경로 및 한 줄 요약 정보가 제공되며, 전체 매개변수 및 스키마 세부 정보는 OpenAPI JSON에 있습니다.

CWM 예측

4 엔드포인트에스

CWM's의 단일 최종 다음 이벤트 배포, 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 엔드포인트에스

매장관리

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

회원

12 엔드포인트에스

로열티 회원 관리

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 엔드포인트에스

주문 수집 → 자동 포인트 적립, 환불 및 정산

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

카탈로그

5 엔드포인트에스

제품 카탈로그(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 엔드포인트에스

라이프사이클, RFM, 가치 계층, 참여, 구매 시기, 선호도(카테고리 선호도 포함), 위험, 동의 및 채널 축 등 태그 카탈로그를 읽고 구성원의 태그를 수동으로 할당/제거합니다.

GET/api/v2/tags
GET/api/v2/members/{id}/tags
POST/api/v2/members/{id}/tags
삭제/api/v2/members/{id}/tags/{tagKey}

사용자 지정 필드

2 엔드포인트에스

모든 엔티티(회원/매장/제품/쿠폰 풀/주문)에 대해 테넌트가 정의한 사용자 지정 필드를 읽을 수 있습니다. 읽기 전용이며, 개인 식별 정보(PII)를 포함하지 않도록 설계되었습니다. 범위: custom_fields:read.

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

캡처

1 엔드포인트

기록 캡처

GET/api/v2/captures

쿠폰

4 엔드포인트에스

쿠폰 풀, 코드 및 사용

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

앰배서더

3 엔드포인트에스

앰배서더 프로그램 - 후보자, ROI 보고서 및 제휴 코드

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

추적

2 엔드포인트에스

페이지 방문/행동 분석 및 이벤트 수집

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

API 핵심 사항

3 엔드포인트에스

API 키 관리

GET/api/v2/api-keys
POST/api/v2/api-keys
삭제/api/v2/api-keys/{id}

인증

7 엔드포인트에스

인증 및 사용자 프로필

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 엔드포인트에스

잠재고객 세그먼트 — 캠페인 타겟팅에 사용되는 구조화된 조건

GET/api/v2/segments
POST/api/v2/segments
GET/api/v2/segments/{id}
패치/api/v2/segments/{id}
삭제/api/v2/segments/{id}

캠페인

3 엔드포인트에스

캠페인 목록 작성 및 초안 생성 (실제로 전송되지 않으며, 담당자가 검토 후 전송합니다.)

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

자동화

2 엔드포인트에스

자동화 — 이벤트로 인해 발생하는 흐름을 나열하고 일시 중지/재개합니다.

GET/api/v2/automations
패치/api/v2/automations/{id}

거래 내역

1 엔드포인트

트랜잭션 전송 — 시스템에서 사람이 명시적으로 트랜잭션 용도(주문 확인, 영수증)로 활성화한 캠페인을 단일 수신자에게 전송합니다. API는 콘텐츠를 작성하지 않으며, 전달률 억제는 항상 적용됩니다. 재시도를 안전하게 하려면 idempotency_key를 전달하세요.

POST/api/v2/transactional/send

수입

4 엔드포인트에스

비동기 대량 가져오기 - 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

이제 프로필 롤업에는 팀의 데이터가 적합성을 지원할 때 계산되는 예측 필드가 포함됩니다.

  • 예상 다음 주문일 — 회원의 구매 간격에 대한 회원별 감마 적합 결과(3회 이상 구매 필요)이며, 간격 통계 및 신뢰도 지표와 함께 반환됩니다.
  • 이메일 클릭 가능성 — 프로필의 집계 참여 기능에서 가져온 팀별 L2 정규화 물류 P(click)입니다.

두 항목 모두 null 정직의 문 아래에 있습니다. 절대 추측이 아닙니다. 소비자는 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개 규칙) 매일 밤 새로운 작업이 실행되어 교차 판매 제안을 제공합니다. 기존 통합 기능은 그대로 유지되며 응답 형식도 변경되지 않습니다.