Utilisation des API

Modifier en ligne

Pour un produit spécifique, vous pouvez utiliser les API incluses dans les plans de ce produit.

Procédure

Remarque : dans la page Icône Aide. d'aide des interfaces utilisateur de l 'API Manager et de l'API Designer, cliquez sur la vignette « Informations sur le produit » pour obtenir des informations sur votre produit et les versions de votre package d' Git. Les informations relatives au produit API Designer dépendent du serveur de gestion associé, tandis que celles concernant l' Git t dépendent de la source à partir de laquelle il a été téléchargé.
Pour utiliser les API d'un produit, procédez comme suit :
  1. Affichez la liste des plans du produit :
    1. Dans le volet de navigation de l'interface utilisateur de l'API Manager, cliquez sur Icône Gérer dans le panneau de navigation de l'interface utilisateur d'API Manager « Gérer », puis sélectionnez le catalogue sur lequel vous souhaitez travailler.
    2. Si les espaces sont activés dans le catalogue, sélectionnez l'espace avec lequel vous souhaitez travailler en suivant les étapes suivantes :
      1. Cliquez sur l'onglet Espaces.
      2. Sélectionnez l'espace sur lequel vous souhaitez travailler.
    3. Si la page Produits n'est pas déjà affichée, cliquez sur l'onglet Produits.
    4. En regard de la version de produit que vous souhaitez utiliser, cliquez sur l'icône des options Icône Options, puis sur Afficher les plans.
      Une fenêtre s'ouvre pour afficher la liste des plans du produit.
  2. En regard du plan requis, cliquez sur Afficher les API.
    Une fenêtre s'ouvre pour afficher la liste des API du plan.
  3. En regard de l'API requise, cliquez sur l'icône des options Icône Options.
    Vous pouvez ensuite sélectionner les options suivantes :
    • Mettre hors ligne : si vous mettez une API hors ligne, elle n'est plus disponible et ne peut plus être appelée. Si nécessaire, vous pouvez rendre l'API à nouveau disponible en sélectionnant En ligne.
    • Afficher les produits : une fenêtre s'ouvre pour afficher la liste de tous les produits incluant l'API. Si nécessaire, vous pouvez cliquer sur l'icône des options Icône Options en regard d'un produit pour l'utiliser. Pour plus d'informations sur les options disponibles, voir Gestion de vos produits.
    • Afficher les plans : une fenêtre s'ouvre pour afficher la liste de tous les plans pour tous les produits incluant l'API. Si nécessaire, vous pouvez cliquer sur l'icône des options Icône Options en regard d'un plan pour l'utiliser. Pour plus d'informations sur les options disponibles, voir Utilisation des plans.