Tutoriel : Créer et publier un produit

S’APPLIQUE À : Tous les niveaux de Gestion des API

Dans Gestion des API Azure, un produit contient une ou plusieurs API, un quota et des conditions d’utilisation. Une fois le produit publié, les développeurs peuvent s’y abonner et commencer à utiliser ses API.

Dans ce tutoriel, vous allez apprendre à :

• Créer et publier un produit
• Ajouter une API au produit
• Accéder aux API du produit

Prérequis

• Apprenez la terminologie relative à Gestion des API Azure.
• Suivez le guide de démarrage rapide suivant : Créer une instance du service Gestion des API Azure.
• Effectuez également toutes les étapes du tutoriel suivant : Importer et publier votre première API.

Créer et publier un produit

Portail

1. Connectez-vous au portail Azure et accédez à votre instance de Gestion des API.

2. Dans le volet de navigation gauche, sélectionnez Produits>+ Ajouter.

   

3. Dans la fenêtre Ajouter un produit, entrez les valeurs décrites dans le tableau suivant pour créer votre produit.

   

   Nom	Description
   Nom complet	Le nom qui doit apparaître dans le portail des développeurs.
   Description	Spécifiez des informations sur le produit, comme son objectif, les API auxquelles il donne accès ainsi que d’autres informations détaillées.
   State	Sélectionnez Publié si vous voulez publier le produit. Avant de pouvoir appeler les API dans un produit, ce produit doit être publié. Par défaut, les nouveaux produits ne sont pas publiés et ne sont visibles que par le groupe Administrateurs.
   Nécessite un abonnement	Sélectionnez si un utilisateur doit s’abonner pour utiliser le produit (le produit est protégé) et si une clé d’abonnement doit être utilisée pour accéder aux API du produit. Si un abonnement n’est pas obligatoire (le produit est ouvert), une clé d’abonnement n’est pas nécessaire pour accéder aux API du produit. Voir Accès aux API du produit plus loin dans cet article.
   Nécessite une approbation	Sélectionnez cette option si vous voulez qu’un administrateur révise et accepte ou refuse les tentatives d’abonnement à ce produit. Si cette option n’est pas sélectionnée, les tentatives d’abonnement sont automatiquement approuvées.
   Limite du nombre d’abonnements	Si vous le souhaitez, limitez le nombre d’abonnements simultanés.
   Conditions légales	Vous pouvez inclure les conditions d’utilisation que les abonnés doivent accepter pour pouvoir utiliser le produit.
   API	Sélectionnez une ou plusieurs API. Vous pouvez aussi ajouter des API après avoir créé le produit. Pour plus d’informations, consultez Ajouter des API à un produit plus loin dans cet article. Si le produit est ouvert (ne nécessite pas d’abonnement), vous pouvez uniquement ajouter une API qui n’est pas associée à un autre produit ouvert.

4. Sélectionnez Créer pour créer votre produit.

Attention

Faites attention lors de la configuration d’un produit qui ne nécessite pas d’abonnement. Cette configuration peut être trop permissive et rendre les API du produit plus vulnérables à certaines menaces de sécurité des API.

Azure CLI

Pour commencer avec Azure CLI :

• Utilisez l’environnement Bash dans Azure Cloud Shell. Pour plus d’informations, consultez Démarrage rapide pour Bash dans Azure Cloud Shell.

  

• Si vous préférez exécuter les commandes de référence de l’interface de ligne de commande localement, installez l’interface Azure CLI. Si vous exécutez sur Windows ou macOS, envisagez d’exécuter Azure CLI dans un conteneur Docker. Pour plus d’informations, consultez Guide pratique pour exécuter Azure CLI dans un conteneur Docker.

  • Si vous utilisez une installation locale, connectez-vous à Azure CLI à l’aide de la commande az login. Pour finir le processus d’authentification, suivez les étapes affichées dans votre terminal. Pour connaître les autres options de connexion, consultez Se connecter avec Azure CLI.

  • Lorsque vous y êtes invité, installez l’extension Azure CLI lors de la première utilisation. Pour plus d’informations sur les extensions, consultez Utiliser des extensions avec Azure CLI.

  • Exécutez az version pour rechercher la version et les bibliothèques dépendantes installées. Pour effectuer une mise à niveau vers la dernière version, exécutez az upgrade.

Pour créer un produit, exécutez la commande az apim product create :

az apim product create --resource-group apim-hello-word-resource-group \
    --product-name "Contoso product" --product-id contoso-product \
    --service-name apim-hello-world --subscription-required true \
    --state published --description "This is a test."

Vous pouvez spécifier différentes valeurs pour votre produit :

Paramètre	Description
--product-name	Le nom qui doit apparaître dans le portail des développeurs.
--description	Spécifiez des informations sur le produit, comme son objectif, les API auxquelles il donne accès ainsi que d’autres informations détaillées.
--state	Sélectionnez Publié si vous voulez publier le produit. Avant de pouvoir appeler les API dans un produit, ce produit doit être publié. Par défaut, les nouveaux produits ne sont pas publiés et ne sont visibles que par le groupe Administrateurs.
--subscription-required	Sélectionnez si un utilisateur doit s’abonner pour utiliser le produit (le produit est protégé) ou si un abonnement n’est pas requis (le produit est ouvert). Voir Accès aux API du produit plus loin dans cet article.
--approval-required	Sélectionnez cette option si vous voulez qu’un administrateur révise et accepte ou refuse les tentatives d’abonnement à ce produit. Si cette option n’est pas sélectionnée, les tentatives d’abonnement sont automatiquement approuvées.
--subscriptions-limit	Si vous le souhaitez, limitez le nombre d’abonnements simultanés.
--legal-terms	Vous pouvez inclure les conditions d’utilisation que les abonnés doivent accepter pour pouvoir utiliser le produit.

Attention

Faites attention lors de la configuration d’un produit qui ne nécessite pas d’abonnement. Cette configuration peut être trop permissive et rendre les API du produit plus vulnérables à certaines menaces de sécurité des API.

Pour voir vos produits actifs, utilisez la commande az apim product list :

az apim product list --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --output table

Vous pouvez supprimer un produit en utilisant la commande az apim product delete :

az apim product delete --product-id contoso-product \
    --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --delete-subscriptions true

Ajouter des configurations

Poursuivez la configuration du produit après l’avoir enregistré. Dans votre instance Gestion des API, sélectionnez le produit dans la fenêtre Produits. Ajouter ou mettre à jour :

Élément	Description
Paramètres	Métadonnées et état du produit
API	API associées au produit
Stratégies	Stratégies appliquées aux API du produit
Contrôle d’accès	Visibilité du produit pour les développeurs ou les invités
Abonnements	Abonnés au produit

Ajout d’API à un produit

Les produits sont des associations d’une ou de plusieurs API. Vous pouvez inclure de nombreuses API et les proposer aux développeurs dans le portail des développeurs. Lors de la création du produit, vous pouvez ajouter une ou plusieurs API existantes. Vous pouvez aussi ajouter des API au produit ultérieurement, à partir de la page Paramètres des produits ou lors de la création d’une API.

Ajouter une API à un produit existant

Portail

1. Dans le volet de navigation gauche de votre instance du service Gestion des API, sélectionnez Produits.
2. Sélectionnez un produit, puis sélectionnez API.
3. Sélectionnez + Ajouter API.
4. Sélectionnez une ou plusieurs API, puis Sélectionner.

Azure CLI

1. Pour voir vos API gérées, utilisez la commande az apim api list :

   az apim api list --resource-group apim-hello-word-resource-group \
       --service-name apim-hello-world --output table
   

2. Pour ajouter une API à votre produit, exécutez la commande az apim product api add :

   az apim product api add --resource-group apim-hello-word-resource-group \
       --api-id demo-conference-api --product-id contoso-product \
       --service-name apim-hello-world
   

3. Vérifiez l’ajout en utilisant la commande az apim product api list :

   az apim product api list --resource-group apim-hello-word-resource-group \
       --product-id contoso-product --service-name apim-hello-world --output table
   

Vous pouvez supprimer une API en utilisant la commande az apim product api delete :

az apim product api delete --resource-group apim-hello-word-resource-group \
    --api-id demo-conference-api --product-id contoso-product \
    --service-name apim-hello-world

Accès aux API du produit

Une fois que vous avez publié un produit, les développeurs peuvent accéder aux API. Selon la configuration du produit, ils devront peut-être s’abonner au produit pour y accéder.

• Produit protégé : Les développeurs doivent d’abord s’abonner à un produit protégé pour avoir accès aux API de ce produit. Quand ils s’abonnent, ils obtiennent une clé d’abonnement qui leur permet d’accéder à toutes les API de ce produit. Si vous avez créé l’instance Gestion des API, vous êtes abonné à chaque produit par défaut, car vous êtes déjà administrateur. Pour plus d’informations, consultez Abonnements dans Gestion des API Azure.

  Lorsqu’un client effectue une demande d’API avec une clé d’abonnement de produit valide, Gestion des API traite la demande et autorise l’accès dans le contexte du produit. Les stratégies et les règles de contrôle d’accès configurées pour le produit peuvent être appliquées.

  Conseil

  Vous pouvez créer ou mettre à jour l’abonnement de l’utilisateur à un produit avec des clés d’abonnement personnalisées via une API REST ou une commande PowerShell.

• Produit ouvert : Les développeurs peuvent accéder aux API d’un produit ouvert sans clé d’abonnement. Toutefois, vous pouvez configurer d’autres mécanismes pour sécuriser l’accès client aux API, notamment OAuth 2.0, des certificats clients et la restriction des adresses IP des appelants.

  Notes

  Les produits ouverts ne sont pas listés dans le portail des développeurs. Les développeurs ne peuvent donc pas s’informer sur ces produits, ni s’y abonner. Ils ne sont visibles que par le groupe Administrateurs. Vous devez utiliser un autre mécanisme pour informer les développeurs sur les API accessibles sans clé d’abonnement.

  Lorsqu’un client effectue une demande d’API sans clé d’abonnement :

  • Gestion des API vérifie si l’API est associée à un produit ouvert. Une API peut être associée au maximum à un produit ouvert.

  • Si le produit ouvert existe, il traite ensuite la demande dans le contexte de ce produit ouvert. Les stratégies et les règles de contrôle d’accès configurées pour le produit ouvert peuvent être appliquées.

Pour plus d’informations, consultez Traitement des requêtes par Gestion des API avec ou sans clé d’abonnement.

Étapes suivantes

Dans ce didacticiel, vous avez appris à :

• Créer et publier un produit
• Ajouter une API au produit
• Accéder aux API du produit

Passez au tutoriel suivant :

Créer une API vide et simuler des réponses de l’API