Prérequis
- Un compte OnetSolutions avec une organisation
Créer une clé API
1
Accéder aux clés API
Rendez-vous dans Paramètres > Clés API depuis votre tableau de bord.
2
Cliquer sur Créer
Cliquez sur le bouton « Créer une clé API ».
3
Configurer la clé
- Nom : donnez à votre clé un nom descriptif (par exemple, « Pipeline CI/CD », « Script de monitoring »)
- Expiration : définissez éventuellement une date d’expiration
- Portées : sélectionnez les permissions associées à cette clé
4
Copier la clé
Après la création, copiez immédiatement la clé API. Elle ne s’affichera qu’une seule fois.
Utiliser les clés API
Incluez votre clé API dans l’en-têteAuthorization de vos requêtes :
Gérer les clés API
Consulter les clés
La page Clés API affiche toutes vos clés actives avec :- Le nom de la clé
- La date de création
- La date de dernière utilisation
- La date d’expiration (si définie)
Révoquer des clés
Pour révoquer une clé API :- Rendez-vous dans Paramètres > Clés API
- Repérez la clé à révoquer
- Cliquez sur le bouton de suppression/révocation
- Confirmez l’action
Jetons de projet
Pour un accès spécifique à un projet, vous pouvez créer des jetons dans Paramètres > Projet > Jetons. Ces jetons sont limités à un projet précis et disposent de permissions restreintes.Bonnes pratiques
Utiliser des noms descriptifs
Utiliser des noms descriptifs
Nommez vos clés en fonction de leur usage (par exemple, « Déploiement Production », « CI Staging ») pour les identifier facilement par la suite.
Définir des dates d'expiration
Définir des dates d'expiration
Pour des besoins temporaires, définissez une date d’expiration afin de révoquer automatiquement la clé.
Utiliser le minimum de permissions requises
Utiliser le minimum de permissions requises
N’accordez que les portées nécessaires à votre application, en suivant le principe du moindre privilège.
Renouveler les clés régulièrement
Renouveler les clés régulièrement
Créez périodiquement de nouvelles clés et révoquez les anciennes pour limiter les risques d’exposition.
Utiliser des variables d'environnement
Utiliser des variables d'environnement
Ne codez jamais les clés API en dur dans votre application. Utilisez plutôt des variables d’environnement.
Documentation de l’API
Référence de l'API
Explorez la documentation complète de l’API pour découvrir les endpoints et paramètres disponibles.

