SocialHub.AI
Ressources · Développeurs

REST API Référence

71 points de terminaison sur 19 ressources. Le SocialHub v2 REST API permet de gérer les magasins, les membres fidélité, les points, les coupons, les captures, le programme Ambassadeur et le suivi. Tous les points de terminaison nécessitent Authorization: Bearer fl_live_…, sauf indication contraire.

URL de basehttps://flash.socialhub.ai/api/v2

Cette référence reflète la référence en direct API. Il s'agit d'un instantané statique du catalogue de points de terminaison, regroupé par ressource. Pour le contrat toujours à jour et lisible par machine (paramètres, corps des requêtes, schémas de réponse), voir OpenAPI JSON →

Authentification

Authentification avec une clé Bearer

Chaque requête s'authentifie avec une clé SocialHub API (fl_live_…) envoyée sous forme de jeton Bearer. Les clés sont attribuées à votre équipe et à chaque outil ; créez-les et gérez-les dans votre compte SocialHub.

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

Vous préférez ne pas inclure la clé en clair dans l'historique de votre terminal ? Exportez-la au format FLASH_API_KEY et référencez la variable d'environnement.

Mode test (bac à sable)

Marquez une clé comme clé de test pour effectuer des tests dans un environnement de test (sandbox) sur la même URL de base — sans environnement ni identifiants supplémentaires. Les données enregistrées avec cette clé (membres, commandes, coupons) sont marquées et masquées dans vos listes et tableaux de bord en production ; un membre de test n'est jamais contacté (les e-mails, SMS et notifications push marketing sont désactivés) et un coupon de test n'est jamais utilisé ; une simple POST /api/v2/test-data/purge efface tout. Expérimentez librement, puis réinitialisez.

Référence

Points de terminaison

71 Points de terminaison répartis dans les groupes de ressources 19. Méthode, chemin et résumé (une ligne) pour chacun ; les paramètres complets et le schéma détaillé se trouvent dans le JSON OpenAPI.

CWM Prévisions

4 point de terminaisons

CWMla distribution finale unique du prochain événement, TimesFM 2,5 prévisions de la demande et fenêtres de fusion privées locataires. Les comportements futurs nécessitent predictions:read; les tendances/fenêtres nécessitent également metrics:readLes probabilités des événements suivants ne sont pas calibrées et dépendent des cibles prises en charge ; les fenêtres de fusion restent null jusqu'à ce qu'ils soient formés et validés.

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

Magasins

4 point de terminaisons

Gestion de la Boutique

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

Membres

12 point de terminaisons

Gestion des membres du programme de fidélité

GET/api/v2/members
POST/api/v2/members
POST/api/v2/members/batch
GET/api/v2/members/{id}
PATCH/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

Commandes

4 point de terminaisons

Ingestion des commandes → attribution automatique de points, remboursements et rapprochement

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

Catalogue

5 point de terminaisons

Catalogue de produits (PIM) — produits, variantes, catégories, marques ; import ERP générique/Shopify

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

Étiquettes de membre

4 point de terminaisons

Lisez le catalogue de balises — cycle de vie, RFM, niveau de valeur, engagement, calendrier d'achat, préférence (y compris l'affinité de catégorie), axes de risque, de consentement et de canal — et attribuez/supprimez manuellement les balises d'un membre.

GET/api/v2/tags
GET/api/v2/members/{id}/tags
POST/api/v2/members/{id}/tags
SUPPRIMER/api/v2/members/{id}/tags/{tagKey}

Champs personnalisés

2 point de terminaisons

Accès aux champs personnalisés définis par le locataire pour toute entité (membre, magasin, produit, pool de coupons, commande). Lecture seule ; contenu non personnel. Portée : custom_fields:read.

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

Captures

1 point de terminaison

Enregistrements de capture

GET/api/v2/captures

Coupons

4 point de terminaisons

Gestion des coupons, codes et utilisation

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

Ambassadeur

3 point de terminaisons

Programme Ambassadeur — candidats, rapport sur le retour sur investissement et codes d’affiliation

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

Suivi

2 point de terminaisons

Analyse des visites de pages et des comportements, et collecte d'événements

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

Clés de API

3 point de terminaisons

API Gestion des clés

GET/api/v2/api-keys
POST/api/v2/api-keys
SUPPRIMER/api/v2/api-keys/{id}

Authentification

7 point de terminaisons

Authentification et profil utilisateur

POST/api/v2/auth/register
POST/api/v2/auth/login
GET/api/v2/auth/profile
PATCH/api/v2/auth/profile
POST/api/v2/auth/change-password
POST/api/v2/auth/forgot-password
POST/api/v2/auth/reset-password

Segments

5 point de terminaisons

Segments d'audience — conditions structurées utilisées pour cibler les campagnes

GET/api/v2/segments
POST/api/v2/segments
GET/api/v2/segments/{id}
PATCH/api/v2/segments/{id}
SUPPRIMER/api/v2/segments/{id}

Campagnes

3 point de terminaisons

Campagnes — liste et création de brouillons (jamais envoyés ; un humain les vérifie et les envoie).

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

Automatisations

2 point de terminaisons

Automatisations : répertoriez les flux déclenchés par des événements et mettez-les en pause/reprenez-les

GET/api/v2/automations
PATCH/api/v2/automations/{id}

Transactionnel

1 point de terminaison

Envoi transactionnel — votre système déclenche l'envoi d'une campagne à un seul destinataire, autorisé explicitement par un utilisateur à un usage transactionnel (confirmations de commande, reçus). API Ne jamais créer de contenu ; la suppression de la délivrabilité est toujours respectée ; passer idempotency_key pour sécuriser les nouvelles tentatives

POST/api/v2/transactional/send

Importations

4 point de terminaisons

Importation groupée asynchrone : importez un fichier CSV/JSONL de membres/commandes et interrogez la tâche (pas de limite de 100 lignes)

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

Données de test

1 point de terminaison

Données du mode test sandbox : suppression de toutes les données créées par une clé de test.

POST/api/v2/test-data/purge
Expédition récente

Champs de profil prédictifs et recommandations plus pertinentes

Deux mises à jour sont intégrées aux points de terminaison existants ; aucune nouvelle interface publique n’est créée et les formats de réponse des points de terminaison de recommandation existants restent inchangés.

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

Les profils agrégés incluent désormais des champs prédictifs , calculés lorsque les données de l'équipe permettent une adéquation :

  • Date prévue de la prochaine commande — une distribution gamma personnalisée, basée sur les intervalles d'achat du membre (nécessite au moins 3 achats), est renvoyée avec les statistiques des intervalles et un indicateur de confiance.
  • Propension à cliquer sur les e-mails  : une métrique logistique L2 régularisée par équipe P(click) issue des fonctionnalités d’engagement cumulées du profil.

Les deux champs sont null en dessous des barrières d'honnêteté ; aucune supposition n'est possible. Les consommateurs doivent gérer null.

Recommendations (public embed + v2)

Le système de notation des achats conjoints est mis à jour et utilise désormais la similarité article-article normalisée par cosinus , ce qui signifie que la force d'une paire n'est plus dominée par les meilleures ventes :

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

Une nouvelle tâche nocturne d'extraction de règles d'association est exécutée par équipe (support / confiance / gain ; MIN_PAIR_ORDERS=3, MIN_CONFIDENCE=0.05, 25 meilleures règles par antécédent par gain) et génère des suggestions de vente croisée. Les intégrations existantes continuent de fonctionner normalement — la structure des réponses reste inchangée.