Skip to main content
Chaque requête à l’API Pioneer nécessite une clé API transmise dans l’en-tête X-API-Key. Créez les clés dans le tableau de bord Pioneer, puis utilisez les endpoints de gestion des clés pour lister et révoquer les clés existantes de manière programmatique.
Stockez les clés API dans des variables d’environnement plutôt que de les coder en dur dans le code source. Par exemple, définissez PIONEER_API_KEY dans votre environnement et lisez-la à l’exécution. Ne validez jamais de clés API dans le contrôle de version.

​
Créer une clé API

POST /create-api-key Génère une nouvelle clé API associée à votre compte. Cet endpoint est utilisé par le tableau de bord Pioneer et nécessite une session de navigateur. Les appels authentifiés avec une clé API existante sont rejetés avec 403 Forbidden pour empêcher l’enchaînement des identifiants. Corps de la requête
​
string
requis
Un nom descriptif pour identifier cette clé. Utilisez des noms qui reflètent la finalité de la clé ou le service auquel elle appartient, par exemple "ci-pipeline" ou "production-inference".
N’utilisez pas une clé API existante pour créer une autre clé API. L’authentification X-API-Key n’est pas acceptée pour cet endpoint ; créez les clés depuis Settings -> API Keys dans le tableau de bord.
Réponse
​
string
La valeur complète de la clé API. C’est la seule fois où elle est renvoyée en clair. Copiez-la immédiatement et stockez-la dans un endroit sûr comme un gestionnaire de secrets ou une variable d’environnement.
​
string
Identifiant unique de la clé. Utilisez cet ID lors de la révocation de la clé.
​
string
Le nom que vous avez attribué à la clé.
​
string
Horodatage ISO 8601 de la création de la clé.
​
string
Derniers chiffres de la clé générée à des fins d’affichage et d’identification.
​
string | null
Horodatage d’expiration ISO 8601 optionnel, ou null lorsque la clé n’expire pas.
​
string
Équipe à laquelle la clé est liée.
​
boolean
Indique si Pioneer a créé un enregistrement client Stripe lors de la création de la clé.
La valeur complète de la clé n’est renvoyée qu’au moment de la création. Si vous la perdez, vous devez révoquer la clé et en créer une nouvelle.

​
Lister les clés API

GET /list-api-keys Renvoie toutes les clés API associées à votre compte. Les valeurs des clés sont masquées dans la réponse. Seules les métadonnées telles que le nom et la date de création sont renvoyées.
Réponse
​
object[]
Tableau d’objets de métadonnées de clés API.
​
number
Nombre de clés renvoyées.

​
Révoquer une clé API

DELETE /delete-api-key Révoque définitivement une clé API. Toute requête utilisant la clé révoquée recevra immédiatement une réponse 401 Unauthorized. Corps de la requête
​
string
requis
L’ID unique de la clé à révoquer, tel que renvoyé par GET /list-api-keys.
La révocation d’une clé est immédiate et irréversible. Assurez-vous que tous les services utilisant la clé sont mis à jour pour utiliser une clé de remplacement avant de révoquer l’ancienne, afin d’éviter les interruptions de service.
Réponse Renvoie 200 OK avec un corps JSON de succès.
​
boolean
Indique si la clé a été révoquée.
​
string | null
Message de statut lisible.