FITsociety Help FR

Configurer une intégration API et gérer les autorisations

4 min de lecture

Documentation technique : toutes les routes API, autorisations et exemples à jour se trouvent sur docs.fitsociety.io. Pour les développeurs, commence par le guide de démarrage rapide de la Public API.

Tu travailles avec un développeur externe ? Définissez à l’avance le système à connecter, les données nécessaires, les actions autorisées et la personne chargée de gérer la connexion. Demande à l’administrateur de créer le client dans la bonne entreprise. Transmets au développeur le lien de documentation et uniquement les informations de connexion nécessaires par un canal sécurisé ; ne partage pas ton mot de passe coach. Utilise un client distinct par intégration pour pouvoir révoquer chaque accès séparément.

Un client API est l’accès pour une seule intégration externe au sein de ton entreprise. Un administrateur autorisé le crée. Ton développeur utilise le client ID et le client secret pour configurer techniquement la connexion.

Dans cet article

1. Créer un client API

  1. Sélectionne la bonne entreprise dans le tableau de bord coach.

  2. Accède à Paramètres → Extensions et Intégrations → Public API.

  3. Ouvre Clients OAuth et choisis Ajouter un client API.

  4. Donne un nom reconnaissable, par exemple « Intégration CRM », et vérifie les scopes sélectionnés.

  5. Accepte uniquement les consentements de données requis pour cette intégration et choisis Créer le client.

  6. Copie le client ID et le client secret affiché une seule fois. Conserve-les en lieu sûr et transmets-les à ton développeur de façon sécurisée.

Utilise un client distinct par intégration. Ne partage pas de mot de passe coach et ne place aucun secret dans un message au support ou dans du code public.

2. Choisir uniquement les droits nécessaires

Les scopes déterminent ce que l’intégration peut faire. Par exemple, clients:read permet de lire les données clients ; clients:write donne accès aux actions d’écriture prises en charge. Vérifie la présélection : la lecture seule n’est pas activée d’office pour chaque nouvelle intégration.

Les données de santé et les communications privées exigent un consentement explicite supplémentaire. L’automatisation des statuts à l’échelle de l’entreprise possède ses propres droits : client_status_automation:read et client_status_automation:write. Le seul droit de modifier des clients n’accorde pas ce dernier droit.

Les droits des clients API existants ne sont pas élargis automatiquement. Tu veux utiliser d’autres scopes ? Crée dans cet écran un nouveau client avec les droits souhaités, demande au développeur de basculer dessus, puis révoque l’ancien client.

3. Faire vérifier la connexion

Le développeur échange les identifiants via OAuth contre un jeton d’accès temporaire. Ce jeton est valable une heure. Commence par une requête en lecture, par exemple le profil du client API, en suivant le guide de démarrage technique.

L’API publique ne dispose pas de sandbox séparée. Les actions d’écriture portent sur les données réelles de l’entreprise. Vérifie d’abord avec lui un workflow convenu avant d’automatiser davantage d’actions.

4. Renouveler, révoquer ou résoudre une erreur

  • Renouveler le secret : à utiliser si le secret est perdu ou a fuité. Les anciens identifiants et les jetons d’accès actifs deviennent invalides ; mets immédiatement l’intégration à jour.

  • Révoquer : arrête ce client API et invalide les jetons actifs. Cette action est irréversible ; pour une nouvelle connexion, crée un nouveau client.

  • 401 : fais vérifier le jeton et les identifiants de connexion.

  • 403 : vérifie les scopes, le consentement aux données et l’accès de l’entreprise.

  • 429 : l’intégration envoie trop de requêtes ; le développeur doit respecter le délai d’attente.

Besoin d’aide ? Communique au support le code d’erreur, l’heure et éventuellement l’identifiant de requête, sans secrets ni jetons d’accès.

Pour aller plus loin

Documentation technique pour ton développeur (en anglais)

Cet article vous a-t-il été utile ? Merci pour votre retour !

Merci, nous lisons chaque commentaire.

Articles liés