Gérer les produits API

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

Les produits d'API regroupent vos API et les mettent à la disposition des développeurs d'applications. Pour obtenir une présentation des produits API, consultez la page Qu'est-ce qu'un produit API ?.

Explorer la page de présentation des produits

La page de présentation des produits affiche tous vos produits d'API et des informations sur chacun d'eux. À partir de cette page, vous pouvez créer un produit d'API, supprimer un produit, ou sélectionner un produit à afficher ou à modifier.

Pour accéder à la présentation des produits, procédez comme suit :

L'interface utilisateur des produits vous permet d'effectuer les tâches courantes suivantes :

Ces tâches sont décrites dans les sections ci-dessous.

Créer un produit API

Cette section explique comment créer un produit d'API à l'aide des interfaces utilisateur Apigee.

Pour créer un produit d'API à l'aide de l'interface utilisateur Apigee, procédez comme suit :

  1. Si vous utilisez l'interface utilisateur d'Apigee dans la console Cloud : sélectionnez Distribution > Produits d'API. Si vous utilisez l'interface utilisateur Apigee classique : sélectionnez Publier > Produits API.
  2. Apigee affiche la page de présentation des produits.
  3. Cliquez sur + Créer. La page de configuration du produit s'affiche.
  4. Configurez le produit d'API. La page de configuration du produit comprend les éléments suivants :
    • Informations sur le produit : informations de base sur le produit d'API telles que son nom, son niveau d'accès (privé, public ou interne) et les champs d'application OAuth.
    • Opérations : groupes de proxys d'API, de chemins de ressources et de méthodes HTTP compatibles avec ce produit d'API. Vous pouvez également définir des limites de quota pour chaque opération.
    • Opérations GraphQL : groupes de proxys d'API, de chemins de ressources et de types d'opérations GraphQL compatibles avec ce produit d'API. Les types d'opérations GraphQL compatibles incluent les requêtes et les mutations. Vous pouvez spécifier l'un des types ou les deux. Comme pour les proxys d'API REST, vous pouvez définir des limites de quota pour chaque opération.
    • Opérations gRPC : spécifiez des proxys d'API gRPC et des méthodes gRPC compatibles avec ce produit d'API. Comme pour les proxys d'API REST, vous pouvez définir des limites de quota pour les opérations.
    • Attributs personnalisés : paires clé/valeur qui vous aident à contrôler l'exécution du proxy de l'API.

    Chacune de ces parties principales est décrite dans les sections ci-dessous.

  5. Lorsque vous avez terminé, cliquez sur Save (Enregistrer). Apigee crée le produit d'API. Vous pouvez désormais associer le produit à une application de développeur. Consultez la section Contrôler l'accès à vos API en enregistrant des applications. Pour obtenir d'autres exemples, consultez les sections Sécuriser une API en exigeant des clés API et Sécuriser une API avec OAuth.

Informations sur le produit

Dans la section Informations sur le produit, saisissez les informations de base de votre nouveau produit d'API. Le tableau suivant décrit les champs de cette section :

Champ Obligatoire ? Description
Name Obligatoire

Définit le nom interne du produit d'API. Vous utilisez cette valeur dans les appels à l'API Apigee qui font référence au produit d'API. La valeur du champ Name peut inclure des caractères alphanumériques, des espaces et les éléments suivants : _ - . # $ %

Par exemple, My API Product ou my-product.
Display name Obligatoire

Définit le nom utilisé dans l'interface utilisateur d'Apigee pour le produit d'API. Vous pouvez modifier le nom à afficher du produit d'API à tout moment.

Le Display name peut inclure des caractères spéciaux.

Par exemple, <My> API Product!!!.
Description Facultatif

Chaîne permettant de mémoriser l'objectif ou la fonction du produit API. La description peut inclure des caractères spéciaux.

Par exemple : The one where I let dev apps read but not write to the "/accounts" endpoints.
Environment Facultatif

Identifie les environnements auxquels le produit d'API autorise l'accès. Si aucun environnement n'est spécifié, tous les environnements sont autorisés par le produit API.

Les environnements que vous sélectionnez dans ce champ limitent l'accès aux proxys d'API en fonction de leur emplacement. Par exemple, si le proxy d'API A est déployé à la fois dans les environnements test et prod, mais que le produit d'API présente uniquement l'environnement test sélectionné, un appel d'API pour l'application de développement correspondante ne permet d'accéder qu'au proxy API A déployé dans l'environnement test. Pour plus d'informations sur les environnements, consultez À propos des environnements et des groupes d'environnements.
Access Obligatoire Niveau d'accès accordé aux utilisateurs de ce produit API. Pour plus d'informations, consultez la section Niveaux d'accès.
Automatically approve access requests Facultatif (par défaut, sélectionné)

Autorise l'approbation automatique des requêtes de clés provenant de toute application pour ce produit d'API. Pour exiger l'approbation manuelle de la clé, désactivez cette option.

Ce paramètre par défaut est sélectionnée ce qui signifie que ce produit d'API approuve automatiquement les requêtes de clé.

Si vous sélectionnez l'approbation manuelle de la clé, vous devez approuver les demandes de clé provenant de toute application utilisant ce produit d'API. Pour approuver manuellement des clés :

Pour plus d'informations, consultez la page Enregistrer des applications et gérer les clés API.
Quota Facultatif

Définit des limites sur le nombre de requêtes autorisées pour ce produit d'API. Cette valeur s'applique à la somme de toutes les requêtes de toutes les opérations pour ce produit d'API.

Cette valeur est remplacée par des limites de quota plus spécifiques définies sur les opérations que vous définissez sur le produit d'API.

La saisie d'une valeur de quota n'applique pas automatiquement de restrictions sur le nombre d'appels pouvant être passés via le produit d'API. Vous devez également ajouter la stratégie de quota aux proxys d'API référencés par le produit d'API.

Pour en savoir plus, consultez la page consacrée aux quotas.
Allowed OAuth scope Facultatif Si vous utilisez OAuth avec le produit d'API, saisissez la liste des champs d'application OAuth que vous voulez que le produit d'API autorise (tels que la lecture ou d'autres champs d'application que les applications envoient avec leurs appels d'API), séparés par une virgule. Pour plus d'informations, consultez la section sur les champs d'application OAuth.

Opérations

Spécifiez les opérations autorisées sur un proxy d'API basé sur HTTP, y compris les chemins d'accès aux ressources, les méthodes HTTP et les quotas. Les opérations vous permettent de contrôler les méthodes REST qui ont accès aux chemins de ressources d'un produit d'API, ainsi que le nombre d'appels pouvant être effectués (avec quota).

Pour configurer les détails de l'opération, cliquez sur + AJOUTER UNE OPÉRATION dans la section Opérations. La vue Opération s'affiche.

Champ Obligatoire ? Description
API proxy Obligatoire

Sélectionnez le proxy d'API à associer à cette opération.
Path Obligatoire

Saisissez le chemin d'accès à la ressource pour l'opération.

Vous pouvez utiliser le chemin d'accès de l'opération pour autoriser ou interdire les requêtes vers des URI spécifiques. Par exemple, si vous définissez la source de l'opération sur le proxy d'API music avec un chemin de base de /music, le produit d'API autorise les appels à tous les sous-chemins sous /music. Toutefois, si vous souhaitez que le produit d'API n'autorise l'accès qu'au chemin d'accès de la ressource venues dont l'URI est /music/venues, ajoutez /venues comme chemin d'accès à l'opération. Vous pouvez effectuer cette action pour toutes les opérations ou pour des opérations spécifiques.

Dans ce cas, les appels à /music/venues?name=paramount sont autorisés, mais les appels à /music/artists?name=Jack%Johnson sont bloqués.

Notez qu'il existe des règles spéciales pour les caractères génériques dans les chemins d'accès aux ressources, comme décrit dans la section Configurer des chemins de ressources.
Methods Facultatif

Sélectionnez une ou plusieurs méthodes de requête HTTP dans la liste déroulante. (Ces méthodes sont parfois appelées verbes HTTP.) Apigee autorise les requêtes adressées au proxy d'API qui ne correspondent qu'aux méthodes sélectionnées.

Par défaut, aucune méthode n'est sélectionnée, ce qui autorise les requêtes utilisant toutes les méthodes HTTP.

Si vous ne sélectionnez pas au moins une méthode, Apigee insère ALL comme valeur de ce champ lorsque vous enregistrez l'opération.

Pour en savoir plus sur les fonctionnalités des méthodes de requête HTTP, consultez la section Méthodes de requête HTTP.
Quota Facultatif Spécifiez les limites de quota pour cette opération. Pour en savoir plus sur le comptage des quotas, consultez la page Comprendre les compteurs de quotas.
Custom attributes Facultatif Consultez la section Attributs personnalisés.

Opérations GraphQL

Pour configurer les détails de l'opération GraphQL, cliquez sur + AJOUTER UNE OPÉRATION dans la section Opérations Graphql. La vue Opération s'affiche. Consultez également la section Utiliser GraphQL.

Champ Obligatoire ? Description
API proxy Obligatoire

Sélectionnez le proxy d'API à associer à cette opération.
Operation name Obligatoire

Spécifiez un nom pour l'opération.
Operation type Facultatif

Sélectionnez un ou plusieurs types d'opérations GraphQL dans la liste déroulante. Apigee autorise exclusivement les requêtes adressées au proxy d'API qui correspondent aux types d'opération que vous sélectionnez.

Par défaut, aucune opération n'est sélectionnée et toutes les requêtes sont autorisées.

Si vous ne sélectionnez pas au moins un type, Apigee insère ALL comme valeur de ce champ lorsque vous enregistrez l'opération.

Pour plus d'informations sur le fonctionnement des types d'opérations GraphQL, consultez la page Requêtes et mutations.
Quota Facultatif Spécifiez les limites de quota pour cette opération. Ce quota remplace le quota défini sur le produit d'API. Consultez la section Quota.
Custom attributes Facultatif Consultez la section Attributs personnalisés.

Opérations gRPC

Pour configurer les détails des opérations gRPC, cliquez sur + AJOUTER UNE OPÉRATION dans la section Opérations gRPC. La vue Opération s'affiche. Consultez également la section Créer des proxys d'API gRPC.

Champ Obligatoire ? Description
API proxy Obligatoire

Sélectionnez le proxy d'API à associer à cette opération.
Service name Obligatoire

Spécifiez un nom pour l'opération.

Pour la version actuelle, il n'existe aucune option permettant de fournir le nom du serveur cible. (Le nom du service et le serveur cible sont identiques.)

gRPC methods in service Facultatif

Saisissez les méthodes gRPC disponibles, en utilisant une liste d'éléments séparés par une virgule dans le cas de plusieurs méthodes.

Quota Facultatif Spécifiez des limites de quota pour ces opérations. Ce quota remplace celui défini sur le produit d'API. Consultez la section Quota.
Custom attributes Facultatif Consultez la section Attributs personnalisés.

Attributs personnalisés

Les attributs personnalisés sont des paires clé/valeur pouvant être utilisées de diverses manières, par exemple pour contrôler l'exécution du proxy de l'API.

Au total, un produit d'API peut comporter jusqu'à 18 attributs personnalisés, y compris ceux définis au niveau des opérations.

Par exemple, vous pouvez créer un attribut personnalisé appelé deprecated avec la valeur true ou false. Dans votre flux de proxy d'API, vous pouvez vérifier la valeur de l'attribut deprecated du produit API. Si sa valeur est true, vous pouvez générer une erreur avec la stratégie RaiseFault, car vous souhaitez que cette opération se comporte comme si elle était obsolète et n'était plus compatible.

Quota

Définit les paramètres de quota au niveau du proxy de l'API ou de l'opération. Si vous définissez un quota, trois champs doivent être renseignés sous Quota :

  1. Le premier champ indique le nombre maximal de requêtes autorisées par une application de développement au proxy d'API pour la période spécifiée.

    Ce champ correspond à l'élément <Allow> d'une stratégie de quota.

  2. Le second champ indique la fréquence de réinitialisation (ou intervalle) du quota.

    Ce champ correspond à l'élément <Interval> d'une stratégie de quota.

  3. Le troisième champ indique le type (ou unité de temps) de réinitialisation, tel que jour, semaine ou mois.

    Ce champ correspond à l'élément <TimeUnit> d'une stratégie de quota.

L'exemple suivant définit une limite de 1 000 requêtes GET, HEAD et TRACE par jour au proxy d'API par jour (toutes les autres requêtes HTTP sont ignorées) :

Ajouter un quota à une opération

L'exemple suivant définit une limite de 42 requêtes toutes les 3 minutes, quelle que soit la méthode HTTP, sur la ressource /mypath :

Ajouter un quota à une opération

Lorsque vous définissez un quota pour une opération, vous devez saisir des valeurs pour les trois champs dans la section Quota.

Vous ne pouvez pas définir de quotas différents pour plusieurs méthodes HTTP sur la même opération. Pour ce faire, vous devez créer plusieurs produits d'API et définir des quotas spécifiques à chaque méthode sur chacun d'entre eux.

Si vous définissez ces valeurs dans la stratégie de quota et sur le produit d'API dans l'interface utilisateur comme décrit ici ou à l'aide de l'API Produit d'API, les paramètres d'API dans l'UI sont prioritaires.

Configurer des chemins de ressources

Notez les règles suivantes pour les chemins de ressources :

  • / : indique que le chemin de base et tous les sous-chemins du chemin de base sont acceptés.
  • /** : indique que tous les sous-chemins du chemin de base sont acceptés (mais pas le chemin de base).
  • /* : indique que seuls les URI se trouvant à un cran au dessous du chemin de base sont acceptés.
  • Les chemins de ressources spécifiés dans le produit d'API ou sur ses opérations s'appliquent à tous les proxys d'API ajoutés au produit d'API.
  • Les chemins de ressource plus inclusifs et moins spécifiques sont prioritaires sur ceux qui sont plus spécifiques. Par exemple, si vous ajoutez / et /**, le chemin d'accès à la ressource / est prioritaire et le chemin d'accès à la ressource /** est ignoré.

Le tableau suivant indique le comportement par défaut d'un produit API pour différents chemins de ressources. Dans cet exemple, le proxy d'API est associé au chemin de base /v1/weatherapikey. Le chemin de ressource du produit API s'applique au suffixe du chemin après le chemin de base.

URI de la demande Autorisé pour / Autorisé pour /* Autorisé pour /** Autorisé pour /*/2/** Autorisé pour /*/2/*
/v1/weatherapikey
/v1/weatherapikey/
/v1/weatherapikey/1
/v1/weatherapikey/1/
/v1/weatherapikey/1/2
/v1/weatherapikey/1/2/
/v1/weatherapikey/1/2/3/
/v1/weatherapikey/1/a/2/3/

Par défaut, un chemin d'accès à la ressource de / dans un produit d'API accepte le chemin de base et tous les sous-chemins d'accès. Par exemple, si le chemin de base du proxy d'API est /v1/weatherapikey, le produit d'API accepte les requêtes adressées à /v1/weatherapikey et à tous les sous-chemins, tels que /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, etc.

Avec les produits API, vous pouvez modifier cette valeur par défaut afin qu'un chemin de ressource de / ne corresponde qu'au chemin de base du proxy d'API. Cela signifie que le produit d'API n'autorisera pas l'accès à un URI qui ne comporte rien après /. Si vous effectuez cette modification, alors dans le tableau ci-dessus seules les deux premières lignes sous "Autorisé pour /" seraient autorisées.

Pour plus d'informations, consultez la section Maîtrisez la configuration des produits d'API.

Modifier un produit API

Pour modifier un produit API, procédez comme suit :

  1. Si vous utilisez l'interface utilisateur d'Apigee dans la console Cloud : sélectionnez Distribution > Produits d'API. Si vous utilisez l'interface utilisateur Apigee classique : sélectionnez Publier > Produits API.
  2. Sélectionnez Publier > Produits API.
  3. Cliquez sur la ligne du produit API que vous souhaitez modifier. Apigee affiche les détails sur le produit d'API.
  4. Cliquez sur MODIFIER.

  5. Modifiez les paramètres du produit d'API, si nécessaire.

    Vous ne pouvez pas modifier une ressource d'API existante. Au lieu de cela, vous devez supprimer la ressource API et en ajouter une nouvelle avec les valeurs corrigées si vous souhaitez la modifier.

    Vous pouvez supprimer une ressource si elle est défectueuse ou nécessite davantage de développement. Une fois supprimée, la ressource ne fait plus partie du produit d'API actuel. Toute application utilisant le produit d'API ne peut plus accéder à la ressource supprimée. Les ressources supprimées sont supprimées d'un produit d'API, mais pas du système. Elles peuvent donc être utilisées par d'autres produits d'API.

  6. (Facultatif) Si la monétisation Apigee est activée, créez un plan tarifaire pour le produit d'API en cliquant sur Ajouter un plan tarifaire ou Ajouter (interface utilisateur classique).

  7. Cliquez sur Enregistrer.

Vos modifications prennent effet dans un court laps de temps (environ cinq minutes).

Supprimer un produit API

Pour pouvoir supprimer un produit API, vous devez annuler l'enregistrement ou dissocier toute application développeur associée à ce produit. Pour ce faire, vous pouvez supprimer les applications ou révoquer les clés API de l'application.

Pour supprimer un produit API, procédez comme suit :

  1. Si vous utilisez l'interface utilisateur d'Apigee dans la console Cloud : sélectionnez Distribution > Produits d'API. Si vous utilisez l'interface utilisateur Apigee classique : sélectionnez Publier > Produits API.
  2. Sélectionnez Publier > Produits API.
  3. Ouvrez le menu Actions sur la ligne du produit à supprimer, puis sélectionnez Supprimer.
  4. Une fois l'opération de suppression confirmée, la suppression prend effet dans un court laps de temps (environ cinq minutes).