Aller au contenu
Guides
Guides

Démarrage rapide

Créez et gérez des clés API standard et des garde-fous avec une clé de gestion RunAPI.

La gestion de la plateforme permet aux administrateurs de compte de créer, inspecter, mettre à jour et révoquer des clés API standard et des garde-fous sans utiliser le tableau de bord pour chaque modification.

Créer une clé de gestion

Suivez le Guide d’authentification pour vous connecter, puis ouvrez la page Clés de gestion et créez une clé de gestion. Stockez-la séparément des clés d’application standard. Envoyez-la en tant que jeton Bearer uniquement aux points de terminaison de gestion de la plateforme.

HTTP
Authorization: Bearer YOUR_MANAGEMENT_KEY

Une clé API standard ne peut pas appeler les points de terminaison de gestion des clés ou des garde-fous. Une clé de gestion valide peut tout de même recevoir 403 Forbidden si son propriétaire ne dispose plus du rôle de compte requis.

Lister les clés API standard

Utilisez GET /api/v1/keys pour inspecter les clés visibles par le compte de la clé de gestion :

SHELL
curl "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY"

Utilisez les identifiants publics retournés pour les requêtes ultérieures de récupération, de mise à jour, de révocation ou d’attribution de guardrails. Ne déduisez jamais les accès à partir d’un nom de clé ou d’un jeton masqué.

Créer et faire tourner une clé

Créez une clé d’application avec POST /api/v1/keys. Le secret complet n’est retourné que dans la réponse de création ; persistez-le dans votre gestionnaire de secrets avant de supprimer cette réponse. La rotation doit créer un remplacement, le déployer dans l’application, vérifier le trafic, puis révoquer l’ancienne clé.

SHELL
curl -X POST "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production worker"}'

credit_limit_windows accepte toute combinaison de plafonds de dépenses glissants 1h, 1d et 7d. Si une fenêtre configurée est épuisée, les appels avec cette clé retournent 429 Too Many Requests jusqu’à ce que l’utilisation quitte la fenêtre. Envoyez un objet vide lors de la mise à jour d’une clé pour effacer tous les plafonds glissants.

Appliquer des garde-fous

Les guardrails sont des politiques de compte réutilisables pour les contrôles de modèle, de fournisseur et de dépenses. Gérez les politiques via /api/v1/guardrails, puis utilisez /api/v1/guardrail_assignments pour les attacher ou les supprimer. Traitez une assignation rejetée comme un échec de politique ou de propriété plutôt que de continuer silencieusement sans le guardrail.

Gérer les erreurs de gestion

  • 401 Unauthorized signifie que le credential est absent, malformé, révoqué ou invalide.
  • 403 Forbidden signifie que la classe de credential ou le rôle du compte ne permet pas d’effectuer l’opération.
  • 404 Not Found signifie que la ressource demandée n’est pas visible pour le compte authentifié.
  • 422 Unprocessable Content signifie qu’une ou plusieurs valeurs soumises enfreignent une règle de ressource.