Créer ou étendre une interface CAPI

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 1 minute de lecture
  • Vous pouvez créer une nouvelle interface CAPI ou étendre une interface existante en ajoutant de nouvelles opérations.

    Avant de commencer

    • Rôle requis : admin
    • Consultez API CAPI par défaut et assurez-vous que le fournisseur et le produit que vous souhaitez créer n'existent pas.
    • Familiarisez-vous avec l'API du fournisseur dans le cloud afin de savoir comment créer des appels REST vers le fournisseur. Si vous n'êtes pas familier avec les en-têtes, les exigences d'authentification, le point de terminaison et les données que vous pouvez transmettre à l'API du fournisseur, vous ne pouvez pas créer vos propres composants CAPI.

    Pourquoi et quand exécuter cette tâche

    Généralement, vous pouvez utiliser les interfaces par défaut fournies dans l'application Cloud Provisioning and Governance. Pour créer une interface personnalisée, basez-la sur une interface existante similaire.

    Procédure

    1. Dans le , accédez portail d'administration du cloudà Conception > API dans le cloud, puis cliquez sur l’onglet Interface .
    2. Cliquez sur Nouveau.
    3. Dans la fenêtre Ajouter l'interface dans le cloud, saisissez un nom pour l'interface, une description utile et sélectionnez la catégorie la plus pertinente à laquelle l'interface API doit appartenir.

      Cet exemple montre une interface pour le stockage Azure :

      Interface de stockage Azure

    4. Dans la liste connexe Opérations de l'interface CAPI, cliquez sur Nouveau.

      Chaque opération que vous créez correspond à un appel d'API REST différent.

    5. Fournissez un nom pour l'opération qui correspond à l'API que vous souhaitez appeler dans le fournisseur.

      Par exemple, vous pouvez créer une opération appelée CreateContainer qui correspond à l'opération Créer un conteneur dans Azure.

      Créer un conteneur

    6. Cliquez avec le bouton droit de la souris sur l'en-tête, puis sélectionnez Enregistrer.
    7. Dans la liste connexe Paramètres d'opération, cliquez sur Nouveau.
    8. Créez un paramètre dont l'opération a besoin, tel que défini par la documentation de l'API REST du fournisseur dans le cloud.

      Si vous ne connaissez pas les paramètres, l'opération échoue. Dans l'exemple de stockage Azure, l'opération CreateContainer doit avoir le nom du conteneur que l'on appelle ici ContainerName.

      Nom du conteneur

    9. Cliquez sur Envoyer.
    10. Ajoutez autant de paramètres que nécessaire pour l'opération, puis ajoutez toutes les opérations dont vous avez besoin.

    Que faire ensuite

    Créer une API CAPI