Clés API
Les clés sk_ de vos serveurs pour appeler l'API publique Wakastart, et les clés wsk_ que vos clients utilisent pour appeler l'API de votre wakapp.
This page has not been translated yet and is shown in French.
Une clé API permet à un serveur d'appeler l'API publique Wakastart sans utilisateur connecté : synchroniser des comptes depuis votre système, envoyer des invitations, lire les utilisateurs d'un client. La clé est rattachée à une application, à un environnement et à un client, et ses droits viennent d'un profil.
Wakastart gère aussi une seconde famille de clés, celles que les organismes clients de votre wakapp utilisent pour appeler l'API de votre wakapp depuis leur propre système d'information. Ces clés wsk_ portent des droits de votre catalogue, aucun droit sur Wakastart : voir Clés de votre wakapp.
Comment ça marche
Wakastart ne conserve que l'empreinte de la clé. À chaque appel, l'API retrouve la clé par cette empreinte, vérifie qu'elle est active, non expirée et utilisée depuis une adresse autorisée, puis exécute l'opération avec le niveau et les droits de la clé, dans le périmètre de son client. Le détail est dans Fonctionnement des clés API.
Choisissez votre approche
Recommandé pour un backend : la clé n'appartient à aucune personne et agit pour un client.
Jeton de l'utilisateurQuand l'action est faite au nom d'un utilisateur connecté, transmettez plutôt son jeton Keycloak.
Commencer
Ce qu'il faut préciser pour recevoir une clé adaptée à votre usage.
Appeler l'APIUn premier appel en cURL et en TypeScript.
Stocker la cléLa ranger dans un secret, jamais dans le code.
Clés de votre wakapp
Bêta En cours de déploiement, pas encore disponible.
Clé sk_ | Clé de votre wakapp | |
|---|---|---|
| Utilisée par | Votre serveur | Le système d'information d'un organisme client |
| Pour appeler | L'API publique Wakastart | L'API de votre wakapp |
| Droits | Profil et niveau Wakastart | Droits du catalogue de votre application |
Types, plafond des droits, validité, rotation et révocation.
Gérer les clés dans la consoleL'onglet Clés API de l'app : créer, modifier, faire tourner, révoquer.
Vérifier une cléL'introspection et le kit pour protéger les routes de votre wakapp.
Proposer les clés dans votre wakappUn écran « Mes clés API » au nom de l'utilisateur connecté.
Jeton de contexteBorner à l'organisme du client une action faite avec votre clé sk_.
Agir sur Wakastart pour un clientInviter un apprenant depuis l'appel d'un client, en toute sécurité.
Fonctionnalités
Les droits de la clé sont ceux de son profil, ni plus ni moins.
Restriction d'adresses IPLimiter l'usage de la clé aux adresses de vos serveurs.
ExpirationDonner une date de fin à la clé et la remplacer sans coupure.
RévocationDésactiver ou supprimer une clé compromise.
TraçabilitéCréation, activation et révocation sont tracées dans le journal d'audit.
Mise en productionLes vérifications avant de brancher une clé de production.
Produits liés
Les droits applicatifs qu'un profil accorde.
Variables et secretsFournir la clé à un service hébergé sur Wakastart.
Utilisateurs et équipesInviter des utilisateurs depuis votre backend.