Passer au contenu principal

​
Aperçu

Les clés d’API fournissent un accès programmatique à CaseBender. Ouvrez Paramètres → Compte → Clés d’API pour gérer les clés disponibles pour votre compte et votre organisation actuelle. La page propose :
  • Une recherche et des filtres par état ou niveau
  • Des identifiants de clé masqués
  • L’état, le niveau, l’heure de la dernière utilisation et le nombre de requêtes
  • Des statistiques d’utilisation
  • Des actions de cycle de vie telles que la rotation, la suspension, la révocation et la suppression
Une clé d’API est un identifiant sensible. Conservez-la dans un gestionnaire de secrets approuvé, ne la versionnez jamais et ne l’incluez jamais dans des journaux, des captures d’écran, des tickets ou des messages de discussion.

​
Prérequis

  • Votre rôle doit autoriser les opérations d’écriture et la gestion des clés d’API.
  • Les scopes disponibles sont filtrés en fonction de votre rôle.
  • La création, la révocation ou la suppression d’une clé peut nécessiter une authentification renforcée.
  • Votre organisation peut imposer des politiques d’authentification et d’accès supplémentaires.
Les rôles en lecture seule peuvent afficher les informations autorisées, mais ne peuvent pas modifier les clés.

​
Créer une clé d’API

1

Ouvrir Clés d’API

Accédez à Paramètres → Compte → Clés d’API.
2

Commencer la création

Sélectionnez Créer une clé d’API.
3

Décrire la clé

Saisissez un Nom explicite et, facultativement, une description qui identifie la charge de travail, son responsable et son objectif.
4

Sélectionner un niveau

Choisissez le niveau adapté au volume de requêtes attendu pour la charge de travail. Les niveaux disponibles vont de Basic à Unlimited.
5

Définir une expiration

Indiquez éventuellement le nombre de jours avant l’expiration. Pour les identifiants de production, privilégiez des durées courtes et conformes à la politique applicable.
6

Sélectionner les scopes

Choisissez au moins un scope. N’utilisez Tout sélectionner que si la charge de travail nécessite légitimement tous les scopes disponibles pour votre rôle.
7

Créer la clé et s’authentifier

Sélectionnez Créer la clé et effectuez l’authentification renforcée lorsqu’elle vous est demandée.
8

Enregistrer l’identifiant

Copiez la clé complète depuis Enregistrez votre clé d’API dans un gestionnaire de secrets approuvé avant de sélectionner Terminé.
La clé complète n’est affichée qu’une seule fois. CaseBender ne conserve que les informations nécessaires pour la valider et l’identifier ; l’identifiant en texte clair ne peut pas être récupéré ultérieurement.

​
Choisir les scopes

Les scopes suivent un modèle associant une ressource et une action, comme cases:read ou organizations:*. Les catégories de scopes peuvent comprendre les dossiers, les alertes, les tâches, les utilisateurs, les équipes, les organisations, les paramètres et la gestion des clés d’API. Appliquez le principe du moindre privilège :
  • Utilisez des scopes en lecture seule pour les charges de travail de création de rapports et de recherche.
  • N’accordez des scopes d’écriture que lorsque l’intégration effectue des mutations.
  • Évitez les scopes avec caractère générique et les scopes administratifs pour les intégrations à usage unique.
  • Créez des clés distinctes pour les services ou environnements sans rapport entre eux.
  • Réexaminez les scopes requis chaque fois qu’une intégration évolue.
Le formulaire de création des Paramètres ne propose que les scopes autorisés pour votre rôle actuel. Les requêtes d’API sont évaluées au regard des scopes de la clé et des autres contrôles de données appliqués.
N’accordez le scope api-keys:write, des scopes avec caractère générique ou des scopes administratifs qu’à des automatisations de confiance explicitement autorisées à créer ou à gérer d’autres identifiants.

​
Choisir un niveau

Le niveau enregistre la classe de service prévue pour une clé. Les niveaux disponibles sont :
  • Basic
  • Standard
  • Professional
  • Enterprise
  • Unlimited
Les limites effectives de requêtes, d’opérations groupées et d’accès concurrents dépendent de la configuration du déploiement. Validez le débit de production et l’application des limites auprès de votre administrateur de plateforme au lieu de supposer que la sélection d’un niveau modifie les limites actives ou rend une clé illimitée.

​
Authentifier les requêtes d’API

Utilisez la clé complète avec l’un des en-têtes à clé unique pris en charge.

​
Recommandé : jeton Bearer

​
Autre possibilité : X-Api-Key

Conservez la clé dans une variable d’environnement ou injectez-la au moyen d’un mécanisme de gestion des secrets. Ne collez pas directement une clé réelle dans l’historique du shell ou dans le code source.
Consultez l’introduction à la référence de l’API pour obtenir d’autres exemples.

​
Comprendre les états des clés

  • Les clés Actives peuvent authentifier les requêtes, sous réserve des vérifications des scopes et des politiques.
  • Les clés Suspendues sont temporairement désactivées et peuvent être réactivées.
  • Les clés Révoquées sont définitivement invalides.
  • Les clés Expirées ont dépassé la date d’expiration configurée.

​
Afficher les statistiques d’utilisation

Ouvrez le menu d’actions d’une clé, puis sélectionnez Afficher les statistiques pour consulter :
  • Le nombre total de requêtes
  • Les requêtes réussies
  • Les requêtes ayant échoué
  • Le temps de réponse moyen
  • Les principaux endpoints
Utilisez ces statistiques pour identifier les identifiants inutilisés, les endpoints inattendus et les charges de travail nécessitant un autre niveau.

​
Effectuer la rotation d’une clé

La rotation remplace le secret actuel par un nouveau.
1

Préparer le consommateur

Vérifiez que vous pouvez immédiatement mettre à jour le service consommateur et que vous disposez d’un plan de retour arrière.
2

Effectuer la rotation

Ouvrez le menu d’actions de la clé, puis sélectionnez Effectuer la rotation de la clé.
3

Enregistrer la nouvelle clé

Copiez le nouvel identifiant affiché dans votre gestionnaire de secrets.
4

Mettre à jour et vérifier

Mettez à jour la charge de travail consommatrice, redémarrez-la ou redéployez-la si nécessaire, puis effectuez une requête de test dans le périmètre autorisé.
La rotation invalide le secret précédent. Coordonnez la modification afin d’éviter une interruption de l’intégration.
La rotation est déclenchée par un opérateur. Le simple enregistrement d’un intervalle de rotation ne garantit pas que CaseBender générera et distribuera automatiquement une clé de remplacement.

​
Suspendre ou réactiver une clé

Utilisez Suspendre pour désactiver temporairement une clé pendant une investigation ou une maintenance planifiée. N’utilisez Réactiver qu’après avoir vérifié que l’identifiant et son consommateur sont dignes de confiance. La suspension est préférable à la suppression lorsque vous avez besoin d’une mesure de confinement réversible.

​
Révoquer une clé

Utilisez Révoquer lorsqu’un identifiant est compromis, n’est plus fiable ou est définitivement retiré. La révocation peut nécessiter une authentification renforcée et ne peut pas être annulée. Après la révocation :
  1. Supprimez le secret de tous les consommateurs.
  2. Examinez les statistiques d’utilisation et les données de télémétrie de sécurité.
  3. Recherchez l’origine des requêtes inattendues.
  4. Ne créez une clé de remplacement distincte que si la charge de travail reste autorisée.

​
Supprimer une clé

La suppression retire l’enregistrement de la clé et sa visibilité directe dans l’interface de gestion. Elle peut nécessiter une authentification renforcée.
Révoquez une clé avant de la supprimer lorsqu’une séquence claire de retrait des identifiants est nécessaire. Le menu d’actions actuel ne présente pas de boîte de dialogue de confirmation distincte pour chaque opération destructrice.

​
Recommandations de sécurité

  • Désignez un responsable humain et un responsable de la charge de travail.
  • Utilisez des clés distinctes pour la production, la préproduction et le développement.
  • Définissez une expiration conforme à votre politique de gestion des identifiants.
  • Effectuez immédiatement la rotation d’une clé en cas de suspicion d’exposition.
  • Surveillez les requêtes ayant échoué et les endpoints inattendus.
  • Révoquez les clés inutilisées au lieu de les laisser actives.
  • N’envoyez jamais de clés par e-mail ou au moyen d’outils de collaboration.

​
Résolution des problèmes

​
La création de la clé est refusée

Saisissez un nom, sélectionnez au moins un scope, vérifiez que votre rôle dispose d’un accès en écriture et effectuez toute authentification renforcée demandée.

​
Une requête d’API renvoie une erreur 401

Vérifiez que la clé active complète est fournie sous forme de jeton Bearer ou au moyen de X-Api-Key, et qu’elle n’a pas expiré, été suspendue ou été révoquée.

​
Une requête d’API renvoie une erreur 403

La clé a été authentifiée, mais ne dispose pas du scope ou de l’accès aux données requis. N’ajoutez que le scope minimal nécessaire au moyen d’un processus autorisé de gestion des clés.

​
Le débit des requêtes est limité

Réduisez la fréquence des requêtes, respectez les indications de nouvelle tentative fournies dans la réponse ou demandez à un administrateur si la charge de travail nécessite un autre niveau.

​
La clé complète n’est plus visible

Les clés en texte clair ne peuvent pas être récupérées. Effectuez la rotation de la clé ou créez-en une autre, puis mettez à jour le consommateur.

​
Référence de l’API

​
Guides associés