Points de terminaison CaseBender
Voir le fichier de spécification OpenAPI
Authentification
Tous les points de terminaison de l’API nécessitent une authentification par clé d’API. Incluez votre clé d’API dans chaque requête en utilisant l’une des méthodes suivantes :Recommandé : jeton Bearer
Incluez votre clé d’API en tant que jeton Bearer dans l’en-têteAuthorization :
Alternative : en-tête X-Api-Key
Vous pouvez également utiliser l’en-têteX-Api-Key :
Créer des clés d’API
Pour créer des clés d’API :- Connectez-vous à votre instance CaseBender
- Accédez à Compte → Clés d’API
- Cliquez sur Créer une clé d’API
- Configurez le nom, la description, le niveau (tier) et les portées (scopes) de la clé
- Enregistrez la clé immédiatement : elle n’est affichée qu’une seule fois et ne peut pas être récupérée ultérieurement
Utiliser les clés d’API
Incluez la clé d’API dans toutes les requêtes de l’API :Avec cURL
Avec Python (bibliothèque requests)
Avec JavaScript/Node.js (fetch)
Niveaux de clés d’API
Des niveaux sont attribués aux clés d’API pour déterminer les limites de débit :Portées des clés d’API
Lors de la création d’une clé d’API, vous pouvez limiter son accès à des opérations spécifiques :alerts:read- Lire les alertesalerts:write- Créer et mettre à jour les alertescases:read- Lire les dossierscases:write- Créer et mettre à jour les dossiersobservables:read- Lire les observablesobservables:write- Créer et mettre à jour les observablesusers:read- Lire les informations des utilisateursadmin:*- Opérations administratives
Erreurs d’authentification courantes
-
401 Unauthorized :
- En-tête
Authorizationmanquant - Clé d’API invalide ou expirée
- La clé d’API a été révoquée ou suspendue
- En-tête
-
403 Forbidden :
- La clé d’API ne dispose pas de la portée requise pour l’opération
- Restrictions d’accès TLP/PAP
-
429 Too Many Requests :
- Limite de débit dépassée pour votre niveau
Bonnes pratiques de sécurité
- Ne partagez jamais votre clé d’API : traitez-la comme un mot de passe
- Faites tourner régulièrement les clés d’API : révoquez les anciennes clés et créez-en de nouvelles périodiquement
- Utilisez des clés différentes pour des applications différentes : cela vous permet de révoquer l’accès par application
- Définissez des dates d’expiration : configurez les clés d’API pour qu’elles expirent automatiquement lorsque c’est possible
- Utilisez les portées minimales requises : n’accordez que les autorisations dont votre application a besoin