Cet article s'adresse aux propriétaires et administrateurs de studio qui connectent d'autres outils à bsport. Il couvre la création, le suivi et la révocation des clés API dans les Paramètres. Pour les notifications d'événements, consultez « Gérer vos webhooks ».
Pour plus d'informations sur l'API publique bsport, veuillez consulter la documentation dédiée
Vue d'ensemble
Une clé API permet à un outil de confiance de lire et de mettre à jour les données de votre studio via l'API bsport. Les outils de reporting, les intégrations personnalisées et les plateformes d'automatisation utilisent des clés pour se connecter.
Gérez vos clés depuis Paramètres > Webhooks & APIs, dans l'onglet API. Chaque clé appartient à votre studio et est associée à un nom d'outil, ce qui vous permet de voir quel outil utilise quelle clé.
Qui peut l'utiliser :
Condition | Ce que vous voyez |
Votre rôle est Propriétaire ou Administrateur, et votre formule bsport inclut l'API publique (Build, Engage ou Elevate) | L'onglet API avec vos clés et le bouton Créer une clé API. |
Votre rôle est Propriétaire ou Administrateur, et votre formule bsport n'inclut pas l'API publique | Le message « Passez à une formule supérieure pour utiliser l'API ». Contactez bsport pour effectuer la mise à niveau. |
Tout autre rôle | Aucun onglet API. L'onglet Webhooks reste disponible si votre rôle dispose de la permission Webhook. |
L'API publique peut aussi être ajoutée à un studio en dehors de ces formules. Contactez bsport pour en faire la demande.
Ce que vous pouvez faire
Créer une clé API pour un outil.
Choisir la durée de validité de la clé : 3 mois, 6 mois ou 1 an.
Voir chaque clé avec son outil, sa date d'expiration, sa date de création, son contact et son statut.
Révoquer une clé lorsque vous cessez d'utiliser un outil ou en cas de suspicion de fuite.
Ouvrir la documentation API depuis le lien en haut à droite de la page.
Cas d'usage courants
Comment créer une clé API
Allez dans Paramètres > Webhooks & APIs et ouvrez l'onglet API.
Sélectionnez Créer une clé API.
Remplissez le formulaire :
Nom de l'outil (obligatoire) : jusqu'à 24 caractères, en utilisant des lettres minuscules, des chiffres, des tirets ou des underscores, par exemple
reporting-tool. Une clé active ne peut pas partager son nom d'outil avec une autre clé active.Expire dans : 3 mois (par défaut), 6 mois ou 1 an. La clé cesse de fonctionner à la fin de cette période.
Email de contact (facultatif) : la personne que bsport contacte au sujet de cette clé. Laissez ce champ vide pour utiliser l'email du propriétaire du studio.
Sélectionnez Créer.
Lisez l'avertissement du formulaire. Une clé donne un accès administrateur complet à votre studio, y compris aux données clients et aux paiements. Ne la partagez qu'avec des outils et des personnes de confiance.
Comment enregistrer votre clé
Après avoir sélectionné Créer, la fenêtre Enregistrez votre clé API affiche la clé. C'est la seule fois où elle sera visible.
Sélectionnez Copier la clé et conservez-la dans un gestionnaire de mots de passe. Ne la partagez pas par email ou par messagerie.
Sélectionnez Copier les en-têtes pour copier ce que votre outil doit envoyer avec chaque requête.
Sélectionnez Fermer.
Si vous fermez la fenêtre avant de copier la clé, bsport vous demande de confirmer. Si vous fermez malgré tout, vous ne pourrez plus revoir la clé : créez-en une nouvelle et révoquez la première.
Comment connecter votre outil
Votre outil envoie deux en-têtes avec chaque requête à l'API bsport :
En-tête | Valeur |
| Le nom d'outil que vous avez choisi. |
| La clé que vous avez copiée. |
Les endpoints et exemples se trouvent dans la documentation API.
Comment révoquer une clé
Dans l'onglet API, trouvez la clé dans la liste.
Sélectionnez Révoquer la clé.
Confirmez dans la fenêtre Révoquer la clé API ?
L'outil cesse de fonctionner immédiatement et cette action est irréversible. La clé reste dans la liste avec le statut Révoquée et la date de révocation. Son nom d'outil redevient disponible.
Comment remplacer une clé avant son expiration
Les clés ne peuvent être ni modifiées ni prolongées. Pour en renouveler une :
Créez une nouvelle clé avec un nouveau nom d'outil, par exemple
reporting-tool-2, ou réutilisez le nom une fois l'ancienne clé expirée ou révoquée.Mettez à jour votre outil avec la nouvelle clé.
Révoquez l'ancienne clé.
Comment ça fonctionne
Configuration. Un propriétaire ou un administrateur crée la clé et la copie une fois.
Activation. La clé fonctionne dès sa création. Votre outil envoie les deux en-têtes avec chaque requête.
Utilisation normale. La liste affiche le statut de chaque clé.
Après l'action. Révoquez une clé pour l'arrêter immédiatement, ou laissez-la expirer.
Statuts des clés
Statut | Signification |
Active | La clé fonctionne et expire dans plus de 30 jours. |
Expire bientôt | La clé fonctionne et expire dans moins de 30 jours. Prévoyez son remplacement. |
Expirée | La clé a atteint sa date d'expiration et ne fonctionne plus. |
Révoquée | Vous avez révoqué la clé. Elle ne fonctionne plus. |
Dans la colonne Contact, Vous indique les clés qui affichent votre propre email.
Comportements importants
Affichage unique. bsport ne stocke pas la clé sous une forme lisible. Personne ne peut l'afficher à nouveau, y compris bsport.
Limite de 50 clés. Un studio peut détenir 50 clés non révoquées. Les clés expirées comptent tant que vous ne les révoquez pas. Une fois la limite atteinte, la page affiche un avertissement et le formulaire de création ne peut pas être envoyé : révoquez une clé expirée pour en créer une autre.
Noms d'outils uniques. Le nom ne peut pas correspondre à celui d'une clé active. Les clés expirées et révoquées libèrent leur nom.
Accès complet. Une clé n'est pas limitée à une seule zone de votre studio. Créez une clé par outil afin de pouvoir révoquer un seul outil sans affecter les autres.
Changements de formule. Si votre formule bsport n'inclut plus l'API publique, l'onglet API affiche le message de mise à niveau et bsport refuse les nouvelles clés.
Les webhooks sont distincts. Les clés API ne créent pas de webhooks. Consultez « Gérer vos webhooks ».
FAQ
J'ai perdu ma clé. Puis-je la revoir ?
Non. Créez une nouvelle clé, mettez à jour votre outil et révoquez celle qui est perdue.
Pourquoi n'ai-je pas d'onglet API ?
Cet onglet est réservé aux propriétaires et administrateurs. Demandez à l'un d'eux de créer la clé.
Pourquoi vois-je « Passez à une formule supérieure pour utiliser l'API » ?
Votre formule bsport n'inclut pas l'API publique. Elle est incluse avec Build, Engage et Elevate. Contactez bsport pour effectuer la mise à niveau ou l'ajouter.
À qui sert l'email de contact ?
C'est la personne que bsport contacte au sujet de la clé. Si vous laissez ce champ vide, bsport utilise l'email du propriétaire du studio.
Puis-je choisir une date d'expiration ?
Le formulaire propose 3 mois, 6 mois ou 1 an.
La révocation d'une clé prend-elle du temps ?
Non. L'outil est refusé immédiatement.