Connecter vos outils avec l'API
L'API permet à une application tierce d'accéder aux données de votre club de manière programmatique : effectifs, calendriers, réservations et facturation. Elle s'active en deux clics et se protège par une clé, une liste d'adresses autorisées et un suivi de consommation.
Savoir si l'API vous concerne
L'API s'adresse à un développeur, pas à un responsable de club. Elle sert à faire dialoguer votre compte avec un logiciel que vous faites écrire ou paramétrer : un site web sur mesure, un outil de comptabilité, un écran d'affichage maison, une passerelle vers un autre système.
Pour les besoins courants — récupérer la liste des adhérents, mettre à jour des abonnements en masse, transmettre des chiffres au bureau — les modules d'import, d'export et de rapports répondent sans écrire une ligne de code.
L'API est proposée en version bêta : son fonctionnement peut encore évoluer.
Activer l'API et récupérer votre clé
- Rendez-vous dans Administration›Réglages›API BETA.
- Activez Activer le module API puis cliquez sur Enregistrer.
- Votre Clé API s'affiche : copiez-la avec le bouton Copier et transmettez-la uniquement à l'outil que vous connectez.
La clé se transmet dans l'en-tête HTTP X-API-Key de chaque requête. Les appels se font obligatoirement en HTTPS ; aucune requête non chiffrée n'est acceptée.
Protéger la clé
Quelques réflexes valent d'être rappelés à l'outil ou au prestataire qui l'utilise :
- ne jamais déposer la clé dans un dépôt de code ; la stocker dans un fichier de configuration hors dépôt ou un gestionnaire de secrets ;
- restreindre les adresses autorisées dès que l'outil appelle depuis un serveur fixe ;
- régénérer la clé au moindre doute — publication accidentelle, fuite de journaux, fin de mission d'un prestataire.
Le bouton Régénérer demande confirmation, puis invalide l'ancienne clé sur-le-champ. Toutes les applications qui l'utilisaient cessent de fonctionner tant qu'elles n'ont pas reçu la nouvelle : prévenez-les avant de cliquer.
Restreindre l'accès par adresse IP
Activez la Restriction par adresse IP : seules les requêtes provenant des adresses que vous listez sont acceptées, dans la limite de 10 adresses IPv4. Saisissez chaque adresse puis validez avec Ajouter ; votre adresse actuelle est affichée à l'écran pour vous aider.
C'est la protection la plus efficace, et la plus souvent négligée : même divulguée, une clé restreinte à l'adresse de votre prestataire reste inutilisable ailleurs.
Suivre la consommation
L'écran affiche en continu ce que consomme votre clé :
- Utilisation cette minute et Utilisation aujourd'hui, chacune rapportée à sa limite quand une limite est configurée ;
- Statistiques d'utilisation : Cette semaine, Ce mois-ci, Total et Dernière requête.
Au-delà des limites indiquées, les requêtes supplémentaires sont temporairement refusées. Un compteur qui frôle en permanence son plafond signale en général un outil mal réglé, qui redemande les mêmes données en boucle plutôt que de les mettre en cache.
La date de dernière requête est utile dans l'autre sens : une clé activée mais jamais appelée depuis des mois est une clé à désactiver.
Découvrir ce que l'API permet
La documentation complète, avec les paramètres et des exemples d'appel, est affichée au bas de l'écran du module. Dans les grandes lignes :
- Utilisateurs : c'est la seule ressource modifiable. Vous pouvez lister, consulter, créer, modifier et supprimer des comptes.
- Configuration : abonnements, profils, groupes et catégories d'âge se consultent, mais se configurent uniquement depuis l'application.
- Réservation : calendriers, créneaux disponibles, réservations et libellés se consultent.
- Facturation : comptes de facturation, commandes et paiements se consultent.
