Une clé API permet à votre propre code, un script ou un outil comme Zapier d'agir sur votre compte Kadens. Vous la créez dans le tableau de bord, choisissez exactement ce qu'elle peut faire, et l'envoyez avec chaque requête.
Une clé est un secret qui appartient à un seul compte. Chaque requête faite avec elle agit comme ce compte et ne peut faire que ce que les autorisations de la clé permettent.
Chaque clé commence par kad_ suivi de 43 caractères aléatoires. Le préfixe permet de repérer facilement une clé si elle se retrouve là où elle ne devrait pas être.
Claude et ChatGPT n'ont pas besoin de clé : ils se connectent en s'authentifiant depuis la page Assistants IA. Utilisez une clé pour les scripts, les outils d'automatisation et tout ce qui envoie un en-tête.
Envoyez la clé dans l'en-tête Authorization de chaque requête, comme un jeton Bearer.
Authorization: Bearer kad_...Gardez la clé hors de votre code : stockez-la dans une variable d'environnement telle que KADENS_API_KEY. Chaque exemple de cette documentation la lit à partir de là.
Le moyen le plus rapide de vérifier qu'une clé fonctionne : demandez à l'API à qui elle appartient.
{
"entity": {
"id": "6f1c2d3e-4b5a-4c7d-8e9f-0a1b2c3d4e5f",
"name": "Barcelona Salsa Studio"
},
"apiKeyId": "9a8b7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d",
"scopes": [
"webhooks.read",
"webhooks.write"
]
}Une autorisation contrôle une action précise de l'API. Une clé ne peut faire que ce que ses autorisations permettent, donnez donc à chaque clé le moins d'autorisations possible dont elle a besoin. Une autorisation d'écriture n'inclut jamais l'autorisation de lecture correspondante.
| Autorisation | Description |
|---|---|
site.read | Lire le contenu du siteConsulter les pages, blocs et paramètres de vos sites. |
site.design_reference.submit | Envoyer des références de designTéléverser des captures et des maquettes que le constructeur de site utilisera comme guide stylistique. |
site.generate | Générer des brouillons de siteCréer de nouvelles pages et de nouveaux blocs en brouillon avec le constructeur de site IA.Clé API uniquement |
site.compose | Composer la mise en page du siteAjouter, réordonner et retirer des blocs sur un brouillon. |
site.theme.configure | Configurer le thème du siteModifier les couleurs, les polices et les espacements qui habillent un brouillon.Clé API uniquement |
site.preview.read | Consulter les aperçus du siteOuvrir l'aperçu d'un brouillon avant sa mise en ligne. |
site.publish | Publier des sitesMettre un brouillon en ligne sur votre site public. |
embed.read | Consulter les widgets intégrésConsulter vos widgets intégrables, leurs statistiques, les sites web où ils ont été vus et les domaines autorisés à les afficher. |
embed.write | Gérer les widgets intégrésCréer, modifier et archiver des widgets intégrables, et ajouter ou retirer les domaines autorisés à les afficher. |
| Autorisation | Description |
|---|---|
catalog.read | Lire votre catalogueConsulter vos cours, leurs éditions et les forfaits et tarifs avec lesquels vous les vendez. |
catalog.course.write | Créer des coursAjouter un cours à votre catalogue, avec son titre, son résumé et ses leçons. |
catalog.plan.write | Définir les tarifs des forfaitsCréer ou modifier les tarifs d'un forfait d'abonnement qui vous appartient. |
media.import | Importer des médiasRécupérer une vidéo depuis une URL publique vers votre médiathèque. |
schedule.write | Définir vos disponibilitésCréer ou remplacer l'horaire hebdomadaire à partir duquel les réservations sont proposées. |
events.read | Lire les événementsConsultez vos événements, leurs sessions et leurs types de billets. |
events.write | Gérer les événementsCréez et modifiez vos événements, leurs sessions et leurs types de billets. |
schedule.read | Lire le planningConsultez le planning de vos cours, ses sessions et les calendriers que vous publiez. |
schedule.manage | Gérer le planningCréer, modifier et annuler les cours, les sessions et les calendriers publiés de votre planning. |
| Autorisation | Description |
|---|---|
orders.read | Lire les commandesConsultez vos commandes, paiements et remboursements. |
subscriptions.read | Lire les abonnementsConsultez les abonnements à vos formules et leur statut. |
bookings.read | Lire les réservationsConsultez les réservations de vos cours et sessions. |
payouts.read | Lire les versementsConsultez vos versements et votre solde. |
pricing.write | Gérer les tarifs et réductionsCréez et modifiez les réductions, options, offres et les règles qui décident qui peut acheter quoi. |
orders.write | Gérer les commandes et remboursementsModifiez les commandes et effectuez des remboursements. Un remboursement rend l'argent à l'acheteur. |
payments.write | Gérer les paiementsModifiez les réglages de paiement, les portefeuilles et l'encaissement de votre compte. Cela peut déplacer de l'argent. |
insights.read | Lire les statistiquesConsultez vos statistiques et les chiffres de votre tableau de bord. |
| Autorisation | Description |
|---|---|
attendees.read | Lire les participantsConsultez qui possède des billets pour vos événements et leurs entrées. |
enrollments.read | Lire les inscriptionsConsultez qui est inscrit à vos cours et sa progression. |
people.read | Lire les données personnellesAccédez aux noms, adresses e-mail et autres données personnelles de vos clients. Sans cette autorisation, elles sont masquées. |
people.write | Gérer les clientsAjoutez et modifiez les personnes de votre CRM, leurs accès et leurs demandes. |
attendees.write | Enregistrer les participantsEnregistrez l'arrivée et le départ des participants à vos événements et sessions. |
| Autorisation | Description |
|---|---|
webhooks.read | Consulter les webhooksConsulter vos endpoints de webhook, leur journal de livraisons et le catalogue d'événements. |
webhooks.write | Gérer les webhooksCréer, modifier et supprimer des endpoints de webhook, renouveler leurs secrets et envoyer, renvoyer ou rejouer des événements. |
| Autorisation | Description |
|---|---|
permissions.policy.read | Lire les politiques d'autorisationConsulter ce que chaque rôle est autorisé à faire sur l'ensemble de votre profil. |
permissions.policy.write | Modifier les politiques d'autorisationAccorder et retirer ce que chaque rôle est autorisé à faire sur l'ensemble de votre profil.Clé API uniquement |
actions.delegate | Agir en votre nomAutorise l'assistant à effectuer en votre nom toute action que vous pouvez faire dans Kadens, dans la limite des autres autorisations que vous accordez. |
| Autorisation | Description |
|---|---|
learning.read | Lire l'apprentissageConsultez examens, notes, certificats, travaux pratiques rendus et progression des élèves. |
learning.write | Gérer l'apprentissageCorrigez les examens, publiez les résultats, délivrez les certificats et évaluez les travaux pratiques. |
| Autorisation | Description |
|---|---|
community.read | Lire la communautéConsultez votre communauté, vos annonces, discussions, avis et FAQ. |
community.write | Gérer la communautéPubliez des annonces, répondez aux discussions et modérez votre communauté, vos avis et vos FAQ. |
| Autorisation | Description |
|---|---|
marketing.read | Lire le marketingConsultez vos envois d'e-mails, rappels, affiliés et récompenses. |
marketing.write | Gérer le marketingCréez et envoyez des e-mails, configurez des rappels et gérez affiliés et récompenses. |
| Autorisation | Description |
|---|---|
terms.read | Lire les conditions de votre compteConsulter la commission, les limites et la période d'essai convenues pour votre compte. |
settings.read | Lire les réglagesConsultez votre profil, vos étiquettes, intégrations et réglages du compte. |
settings.write | Modifier les réglagesModifiez votre profil, vos étiquettes, intégrations et réglages du compte. |
| Sujet | Description |
|---|---|
Réémettre | Crée une nouvelle clé avec le même nom, les mêmes autorisations et la même expiration. L'ancienne clé cesse de fonctionner immédiatement, mettez-la donc à jour partout où elle est utilisée. |
Révoquer | Désactive la clé immédiatement. Toute intégration qui l'utilise cesse de fonctionner. Cette action est irréversible. |
Expiration | Une clé créée avec une expiration cesse de fonctionner à cette date. Une clé sans expiration fonctionne jusqu'à ce que vous la révoquiez. |
Dernière utilisation | Le tableau de bord affiche la dernière utilisation de chaque clé. Une clé que personne n'a utilisée depuis longtemps est une bonne candidate à la révocation. |
Le code de statut indique à votre intégration quoi faire ensuite.
| Statut | Signification |
|---|---|
401 | La clé est absente, mal formatée, révoquée ou expirée. Vérifiez l'en-tête Authorization, ou créez une nouvelle clé. |
403 | La clé fonctionne mais lui manque l'autorisation dont cette requête a besoin. Réémettre conserve les mêmes autorisations, créez donc plutôt une clé avec l'autorisation manquante. |
{
"statusCode": 403,
"message": "API key missing required scope",
"timestamp": "2026-10-01T10:00:00.000Z",
"path": "/api/v1/me",
"requestId": "req_7c1e0b"
}Cet article vous a-t-il aidé ?