Skip to main content
Les clés API de gestion (Management API Keys) offrent un moyen programmatique de gérer l’ensemble du cycle de vie des clés API de modèle (Model API Keys). Elles sont conçues pour les équipes d’entreprise, les plateformes SaaS et les systèmes d’automatisation qui doivent créer, distribuer, faire pivoter, activer, désactiver ou révoquer des clés sans dépendre d’opérations manuelles dans la console. Les clés API de gestion sont des identifiants administratifs et sont limitées aux opérations de gestion de clés. Elles ne peuvent pas être utilisées pour appeler les points de terminaison d’inférence ou de complétion de modèles.

1. Vue d’ensemble

Les clés API de gestion sont destinées à des scénarios tels que :
  • L’émission de clés API de modèle distinctes pour différents clients, projets ou environnements
  • L’application de limites d’utilisation et de cycles de réinitialisation automatique aux clés API de modèle en aval
  • La rotation, la désactivation ou la révocation de clés de manière programmatique
  • L’application d’une gestion des clés selon le principe du moindre privilège dans les flux de travail SaaS, multi-tenant et axés sur la conformité
Capacités principales :
  • Isolation stricte des permissions pour les opérations de gestion de clés
  • Automatisation complète du cycle de vie des clés API de modèle
  • Limites d’utilisation et cycles de réinitialisation configurables
  • Conçu pour les services côté serveur, les outils internes et les flux de provisionnement automatisés

2. Surfaces API et limites d’authentification

La gestion des clés est répartie sur deux surfaces API, chacune avec son propre modèle d’authentification : Important :
  • Une Management API Key ne peut être utilisée qu’avec /api/v1/model-router/keys
  • Une Management API Key ne peut pas être utilisée avec /v1/management-keys
  • /v1/management-keys ne prend en charge que l’authentification JWT
  • Le secret complet n’est renvoyé qu’une seule fois lors de la création d’une clé et ne peut pas être récupéré ultérieurement

3. Règles de base

  • Chaque compte peut créer jusqu’à 10 clés API de gestion
  • Les clés API de gestion sont activées immédiatement après leur création
  • Le secret complet de la clé API de gestion n’est renvoyé qu’une seule fois
  • Les réponses ultérieures de liste et de détail ne renvoient que des valeurs de clé masquées
  • Les clés API de modèle sont actuellement supprimées de manière logicielle (soft-delete) plutôt que définitivement

4. URL de base

L’URL de base de l’API publique est :
Préfixes de routes utilisés dans ce document :

5. Créer une clé API de gestion

Avant d’utiliser l’API de gestion, créez d’abord une clé API de gestion dans la console DGrid :
1

Ouvrez la page des clés API de gestion

2

Cliquez sur Créer

3

Saisissez un nom de clé

4

Effectuez la vérification de sécurité requise

5

Copiez et stockez la clé en lieu sûr immédiatement après sa création

Si vous exposez ce flux dans votre propre interface, informez clairement les utilisateurs que le secret n’est affiché qu’une seule fois et doit être stocké immédiatement.

6. Authentification

Ce document couvre deux modes d’authentification :
  • Les points de terminaison sous /v1/management-keys nécessitent un JWT
  • Les points de terminaison sous /api/v1/model-router/keys nécessitent une clé API de gestion
Utilisez l’en-tête suivant lors de l’appel des points de terminaison /api/v1/model-router/keys :

7. Points de terminaison du cycle de vie des clés API de gestion

Ces points de terminaison sont utilisés pour créer, consulter, mettre à jour, activer, désactiver et supprimer des clés API de gestion. Tous nécessitent une authentification JWT. Exemple de réponse de création :
Remarques :
  • key n’est renvoyé qu’une seule fois, au moment de la création
  • keyPreview est la valeur d’affichage masquée

8. Gérer les clés API de modèle avec une clé API de gestion

Tous les points de terminaison de cette section utilisent :

8.1 Champs de requête

L’implémentation actuelle prend en charge les champs suivants lors de la création ou de la mise à jour d’une clé API de modèle : Remarques :
  • Si vous connaissez le limit_reset d’OpenRouter, l’équivalent le plus proche dans l’implémentation actuelle de DGrid est cycle
  • expiredAt doit utiliser un horodatage ISO 8601 UTC tel que 2026-12-31T23:59:59Z

8.2 Lister les clés

  • Méthode : GET
  • Chemin : /api/v1/model-router/keys
  • Paramètres de requête :
    • page : numéro de page, par défaut 1
    • size : taille de page, par défaut 20, maximum 100
Remarques d’implémentation :
  • La pagination utilise page et size, et non limit et offset
  • La recherche par nom partiel n’est actuellement pas prise en charge
  • Le filtrage disabled n’est actuellement pas pris en charge
Exemple de requête :
Exemple de réponse :
Remarques sur les champs :
  • key : valeur de la clé API masquée
  • usageInCycle : utilisation au sein du cycle actuel
  • usageInTotal : utilisation cumulée
  • enabled : état d’activation actuel
  • groupName : nom du groupe

8.3 Créer une clé API de modèle

  • Méthode : POST
  • Chemin : /api/v1/model-router/keys
Exemple de requête :
Exemple de corps de requête :
Exemple de réponse :
Remarques :
  • key est la valeur complète de la clé API et n’est renvoyée qu’une seule fois
  • Stockez-la immédiatement dans un système de gestion de secrets sécurisé

8.4 Obtenir les détails d’une clé

  • Méthode : GET
  • Chemin : /api/v1/model-router/keys/{id}
Remarque d’implémentation :
  • L’implémentation actuelle utilise id (UUID), et non key_hash
Exemple de requête :
Exemple de réponse :

8.5 Mettre à jour une clé API de modèle

  • Méthode : PUT
  • Chemin : /api/v1/model-router/keys/{id}
Champs de mise à jour actuellement pris en charge :
  • name
  • limit
  • cycle
  • groupId
Exemple de requête :
Exemple de corps de requête :
Remarque d’implémentation :
  • La méthode de mise à jour actuelle est PUT, et non PATCH

8.6 Désactiver une clé API de modèle

  • Méthode : POST
  • Chemin : /api/v1/model-router/keys/{id}/disablement
Exemple de requête :
Une fois désactivée, la clé API ne peut plus être utilisée pour les appels de modèle.

8.7 Activer une clé API de modèle

  • Méthode : POST
  • Chemin : /api/v1/model-router/keys/{id}/enablement
Exemple de requête :

8.8 Supprimer une clé API de modèle

  • Méthode : DELETE
  • Chemin : /api/v1/model-router/keys/{id}
Exemple de requête :
Remarque d’implémentation :
  • La suppression est actuellement une suppression logicielle (soft delete) et non une suppression physique

9. Exemple d’utilisation

10. Codes de statut HTTP et codes d’erreur

11. Format de réponse standard

Les réponses réussies utilisent l’enveloppe suivante :
Remarques :
  • Les requêtes réussies renvoient un statut HTTP 200
  • Les réponses de création peuvent inclure la clé secrète complète dans data
  • Les points de terminaison de liste et de détail renvoient généralement des valeurs de clé masquées
  • Les secrets complets pour les clés API de gestion et les clés API de modèle ne sont renvoyés qu’une seule fois