Présentation des clés API d’administration

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 2 minutes de lecture

    • Vous pouvez utiliser des appels d’API d’administration pour accéder à la fonctionnalité d’administration sans utiliser l’interface d’interface utilisateur d’administration et un navigateur.

    CPQ fournit des clés API administrateur que vous pouvez utiliser pour accéder aux fonctionnalités d’administration via des appels d’API au lieu d’utiliser un navigateur et l’interface d’administration CPQ .

    Pour une présentation des CPQ clés API administrateur, visionnez la vidéo suivante :

    Clés API de l’administrateur

    Page Clés d’API d’administrateur

    Pour accéder à la page Clés API d’administration dans CPQ, cliquez sur la flèche pour développer la section Utilitaires dans CPQ Admin. L’onglet Clés d’API administrateur apparaît dans le menu.

    Clés d’administrateur

    Ajouter une nouvelle clé API administrateur

    Pour ajouter une nouvelle clé API administrateur, cliquez sur Nouveau en haut de l’écran.

    Ajouter une clé administrateur

    Tous les paramètres sont requis.

    1. Nom : nom de la clé API de l’administrateur
    2. ID d'utilisateur
    3. Date d’expiration : date d’expiration de la clé
    4. Autorisations : autorisations affectées à la clé

    Choisissez les autorisations qui correspondent à votre cas d’utilisation avant de cliquer sur Enregistrer.

    Autorisations de clé API d’administrateur

    Autorisations de clé API

    1. Lecture (obligatoire, par défaut) : accès en lecture seule, généralement pour les demandes GET
    2. Modifier : créer, lire, mettre à jour et supprimer l’accès à la plupart des objets, y compris les champs et les règles
    3. Déployer : permet le déploiement de plans et l’accès à l’historique des déploiements
    4. En bloc : permet d’importer et d’exporter des données, telles que des tables gérées, vers et depuis CPQ
    5. Administrateur : autorisations complètes pour toutes les fonctionnalités d’administration
    6. Données de l’utilisateur final : accès aux API des données de l’utilisateur final

    Lorsque vous avez terminé d’attribuer des autorisations, cliquez sur Enregistrer. La boîte de dialogue se met à jour pour afficher la nouvelle clé API administrateur.

    Ajouter une clé API

    1. Afficher la clé API de l’administrateur
    2. Copier la clé dans le presse-papiers
    3. Fermer la boîte de dialogue
    Important :
    Vous pouvez copier une clé API administrateur uniquement lorsqu’elle est créée. Assurez-vous de copier et de stocker la clé.

    Accéder aux API d’administration à l’aide de clés API

    Pour utiliser une clé API d’administrateur dans les demandes d’API, utilisez la clé API avec l’authentification par jeton de porteur.

    • En-tête : en-tête d’autorisation
    • Clé : autorisation
    • Valeur : porteur <clé API administrateur>

    Exemple d’en-tête :

    autorisation : porteur Qda_UdoiYipb15Le11En8axEuN71FA6Vt_cw

    Lorsque vous utilisez une clé API d’administrateur, vous utilisez différents points de terminaison pour accéder aux API d’administration.

    • Pour les points de terminaison Administrateur général (/a/Admin/...), le point de terminaison à utiliser est (/api/Admin/...).

      Par exemple (récupération d’une liste de règles) :

      • Appel d’API dans l’interface utilisateur de l’administrateur : /a/Admin/v3/rules ?page=0&size=100&sort=modified %2CDESC
      • Appel d’API à l’aide des clés d’administrateur : /api/Admin/v3/rules ?page=0&size=100&sort=modified %2CDESC
    • Pour les points de terminaison de table gérée (/a/managed_tables/...), le point de terminaison à utiliser lors de l’accès avec une clé API est (/api/managedTables/...)

      Par exemple (récupération du schéma d’une table gérée) :

      • Appel d’API dans l’interface utilisateur de l’administrateur : /a/managed_tables/v1/managedTables/{tableName}/metadata
      • Appel d’API à l’aide des clés d’administrateur : /api/managedTables/v1/managedTables/{tableName}/metadata