Paramètres › Accès API (/settings/api-access) permet à votre site web, ou à l’agence qui le construit, d’afficher vos formations, vos cours avec leurs dates, vos implantations et vos catégories de permis, toujours à jour. Chaque site web reçoit sa propre connexion avec un identifiant client et un secret. Une connexion ne voit que ce que cette société propose : vos formules publiées et les cours ouverts qui doivent encore commencer. Elle ne voit jamais les clients, les instructeurs ni quoi que ce soit d’autre.
Comment connecter un site web ?
- Ouvrez Paramètres › Accès API. Avec plusieurs sociétés, choisissez d’abord la Société.
- Cliquez sur Nouvelle connexion, donnez-lui un nom (par exemple « Site de l’auto-école ») et cliquez sur Enregistrer.
- Copiez l’Identifiant client et le Secret et transmettez-les à la personne qui gère votre site web, avec l’Adresse du jeton et l’Adresse de l’API affichées sur la page. Le secret n’est affiché qu’une seule fois.
- Cliquez sur Je l’ai conservé.
Votre développeur web utilise le flux standard OAuth 2.0 client credentials : le site web demande un jeton à l’adresse du jeton avec l’identifiant client et le secret, puis lit le catalogue à l’adresse de l’API. Le secret doit se trouver sur le serveur du site web, jamais dans la page web elle-même.
Que voit le site web ?
- Formations : les produits actifs pour lesquels Publier en ligne est activé (pas les frais), avec leur prix TVA comprise.
- Cours : les cours ouverts et complets qui doivent encore commencer, avec leurs séances, leur implantation et les places restantes. Un cours complet est affiché comme complet. Seuls les cours dont la formule a Publier en ligne activé apparaissent, de sorte que les cours internes ou d’entreprise restent hors de votre site web.
- Implantations et catégories de permis (uniquement les actives ; une catégorie désactivée n’est plus affichée, même pas sur un cours).
Pour changer ce qui apparaît, modifiez le produit (Publier en ligne) ou le cours, comme vous le faites pour l’assistant d’inscription.
Comment arrêter un site web, ou changer le secret ?
- Nouveau secret (la flèche circulaire) : l’ancien secret et tout ce qui a été délivré avec lui cessent immédiatement de fonctionner. Transmettez le nouveau secret au site web.
- Désactiver (le bouton pause) : la connexion s’arrête immédiatement, et tout ce qui a été délivré auparavant reste invalide ; réactivez-la plus tard avec le bouton lecture. Le site web se connecte alors à nouveau avec le même identifiant client et le même secret.
- Supprimer (la corbeille) : la connexion est supprimée définitivement.
Chaque nouvelle connexion, nouveau secret, changement de nom, désactivation ou activation et suppression est listé sous Historique en bas de la page, avec qui l’a fait et quand ; une connexion supprimée y reste listée.
Faites-le immédiatement lorsqu’un secret a pu fuiter ou lorsque vous changez d’agence web.
Bon à savoir
- Lorsque votre licence a expiré, la connexion s’arrête : le site web ne reçoit plus de jeton ni de données (message
license_expired) jusqu’au renouvellement de la licence. Rien ne doit être modifié sur le site web. - Seuls les utilisateurs dont le rôle a Gérer l’accès API pour les sites web voient cette page ; le rôle standard Administrateur l’a. Elle nécessite la vérification en deux étapes.
- Dernière utilisation montre quand le site web s’est connecté pour la dernière fois.
- Une société peut avoir au maximum 10 connexions.
Pas (encore) possible
- Créer depuis le site web un lien direct vers une formation ou un cours dans l’assistant d’inscription.
- Permettre à un site web d’envoyer des inscriptions ou des questions via l’API.
Vous n'avez pas trouvé ce que vous cherchiez ?
Soumettre un ticket