FansquareDocumentation
ENOuvrir l’app

Développeurs

L'API Fansquare

Relier Fansquare à vos propres outils avec l'API publique et les webhooks.

L'API publique donne à vos propres outils accès aux données de l'agence : créatrices, employés, ventes et revenus, messages envoyés, fans, publications. Les webhooks, eux, préviennent votre serveur dès qu'une vente tombe ou qu'un fan change d'employé. Tout se règle dans Paramètres › API développeur, réservé au propriétaire de l'agence.

Le détail technique est dans la référence de l'API, en anglais.

À quoi ça sert

L'API sert aux intégrations de serveur à serveur : un tableur de revenus alimenté par un script, un tableau de bord interne, un outil de BI, un bot. Appelez-la depuis votre serveur, pour que la clé reste hors du navigateur.

Les clés d'API

Paramètres › API développeur › API liste les clés de l'agence. Chacune est identifiée par son nom et par le début de la clé, fsq_live_ suivi de quelques caractères, jamais par la clé entière.

Paramètres › API développeur › API : trois clés, avec leurs accès, leurs créatrices, leur activité et leur statutParamètres › API développeur › API : trois clés, avec leurs accès, leurs créatrices, leur activité et leur statut
  1. 1

    Cliquez sur Générer une clé

    Le bouton est en haut à droite de Clés API.

  2. 2

    Réglez la clé

    Donnez-lui un Nom, puis choisissez ses Accès : Lecture seule, Accès complet ou Personnalisé, permission par permission. Limitez-la au besoin à une Sélection de créatrices, et fixez une Expiration : Jamais, Dans 30 jours, Dans 90 jours ou Dans 1 an.

  3. 3

    Copiez la clé

    Après Générer la clé, la clé s'affiche une seule fois. Cliquez sur Copier la clé, puis rangez-la dans votre gestionnaire de secrets.

Quiconque détient une clé lit les données de l'agence. Une clé perdue ne se réaffiche pas : révoquez-la et générez-en une autre.

L'icône au bout d'une ligne révoque la clé. La révocation est définitive. Une agence garde au plus 20 clés non révoquées. Les détails des clés et de leurs accès sont dans la référence.

Les webhooks

Paramètres › API développeur › Webhooks envoie les événements de l'agence à vos adresses HTTPS, au moment où ils arrivent : Vente créée, Vente remboursée, Assignation modifiée, Relance ou arrêt de l'IA demandé.

Paramètres › API développeur › Webhooks : deux endpoints, l'un actif, l'autre en pauseParamètres › API développeur › Webhooks : deux endpoints, l'un actif, l'autre en pause

Ajouter un endpoint demande un nom, l'URL de destination, les Événements à recevoir et les créatrices concernées. Chaque livraison est signée : le secret de signature, qui commence par fsq_whsec_, s'affiche une seule fois à la création. Sur chaque ligne, vous pouvez Modifier, Envoyer un test, Mettre en pause, Régénérer le secret ou Supprimer.

L'onglet Activité compte les livraisons des 7 derniers jours et liste les Échecs récents, qu'un clic sur Renvoyer relance. Un endpoint qui échoue trop souvent passe en Coupé après échecs répétés. Pour vérifier les signatures et traiter les livraisons, voir les webhooks dans la référence.