Hub d'API Apigee

Le connecteur Apigee API Hub vous permet de gérer, de découvrir et de gouverner les API du portefeuille de votre organisation.

Versions compatibles

Ce connecteur est compatible avec la version 1 du hub d'API Apigee.

Avant de commencer

  • Dans votre projet Google Cloud, effectuez les tâches suivantes :

    • Assurez-vous que la connectivité réseau est configurée. Pour en savoir plus sur les schémas de réseau, consultez Connectivité réseau.
    • Attribuez le rôle IAM roles/connectors.admin à l'utilisateur qui configure le connecteur.
    • Activez les services suivants :
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Pour savoir comment activer des services, consultez Activer des services. Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer au moment de configurer le connecteur.

  • Si vous utilisez l'authentification par compte de service au lieu de l'authentification OAuth 2.0, assurez-vous que le compte de service dispose des autorisations appropriées. Pour en savoir plus, consultez Rôles IAM prédéfinis.

Créer une connexion au hub d'API Apigee

Une connexion est propre à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

  1. Dans la console Cloud, accédez à la page Integration Connectors > Connexions, puis sélectionnez ou créez un projet Google Cloud.

    Accéder à la page "Connexions"

  2. Cliquez sur + Créer pour ouvrir la page Créer une connexion.
  3. Dans la section Emplacement, sélectionnez un emplacement dans la liste Région, puis cliquez sur Suivant.

    Pour obtenir la liste de toutes les régions disponibles, consultez Emplacements.

  4. Dans la section Détails de connexion, procédez comme suit :
    1. Sélectionnez Apigee API Hub dans la liste Connecteur.
    2. Sélectionnez une version de connecteur dans la liste Version du connecteur.
    3. Dans le champ Nom de connexion, indiquez le nom de l'instance de connexion. Le nom de la connexion peut contenir des lettres minuscules, des chiffres ou des traits d'union. Il doit commencer par une lettre et se terminer par une lettre ou un chiffre. Il ne doit pas dépasser 49 caractères.
    4. (Facultatif) Saisissez une description de l'instance de connexion.
    5. (Facultatif) Activez Cloud Logging, puis sélectionnez un niveau de journalisation. Par défaut, le niveau de journalisation est défini sur Error.
    6. Compte de service : sélectionnez un compte de service disposant des rôles requis.
    7. (Facultatif) Configurez les paramètres de nœuds de connexion.
      • Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
      • Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.

      Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter davantage de transactions pour une connexion, vous devez disposer de plus de nœuds. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour une meilleure disponibilité) et le nombre maximal sur 50.

    8. Cliquez sur Suivant.
  5. Dans la section Destinations, saisissez des informations sur l'hôte distant (système backend) auquel vous souhaitez vous connecter.
    1. Dans le champ Type de destination, sélectionnez une destination.
    2. Dans le champ Adresse de l'hôte, spécifiez le nom d'hôte ou l'adresse IP de la destination.
    3. Facultatif : Pour saisir d'autres destinations, cliquez sur + AJOUTER UNE DESTINATION.

    4. Cliquez sur Suivant.
  6. Dans la section Authentification, saisissez les informations d'authentification.
    1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.

      Les types d'authentification suivants sont compatibles avec la connexion au hub d'API Apigee :

      • Code d'autorisation OAuth 2.0
      • Authentification par compte de service
    2. Pour savoir comment configurer ces types d'authentification, consultez Configurer l'authentification.

    3. Cliquez sur Suivant.
  7. Vérifiez les informations de connexion et d'authentification, puis cliquez sur Créer.

Configurer l'authentification

Saisissez les informations en fonction de l'authentification que vous souhaitez utiliser.

  • Code d'autorisation OAuth 2.0 : sélectionnez cette option pour configurer l'authentification à l'aide d'un flux de connexion utilisateur Web. Spécifiez les informations suivantes :
    • ID client  : ID client requis pour se connecter à votre service de backend Apigee API Hub.
    • Niveaux d'accès : liste des niveaux d'accès souhaités, séparés par une virgule. Pour afficher tous les niveaux d'accès OAuth 2.0 acceptés par le service Google requis, consultez la section correspondante sur la page Champs d'application OAuth 2.0 pour les API Google.
    • Code secret du client : sélectionnez le secret Secret Manager. Vous devez avoir créé le secret Secret Manager avant de configurer cette autorisation.
    • Version du secret : version du secret Secret Manager pour le code secret du client.

    Pour le type d'authentification Authorization code, vous devez autoriser la connexion après l'avoir créée.

  • Authentification par compte de service : sélectionnez cette option pour vous authentifier à l'aide du compte de service que vous avez fourni lors des étapes précédentes de la configuration de cette connexion. Assurez-vous d'avoir fourni le compte de service disposant des rôles et des autorisations IAM appropriés pour l'authentification.
    • Niveaux d'accès  : sélectionnez les niveaux d'accès OAuth 2.0 requis dans le menu déroulant. Pour en savoir plus, consultez Niveaux d'accès.

Autoriser la connexion

Si vous utilisez le code d'autorisation OAuth 2.0 pour authentifier la connexion, effectuez les tâches suivantes après avoir créé la connexion.

  1. Sur la page Connexions, recherchez la connexion que vous venez de créer.

    Notez que l'état du nouveau connecteur sera Autorisation requise.

  2. Cliquez sur Autorisation requise.

    Le volet Modifier l'autorisation s'affiche.

  3. Copiez la valeur de l'URI de redirection dans votre application externe.
  4. Vérifiez les détails de l'autorisation.
  5. Cliquez sur Autoriser.

    Si l'autorisation aboutit, l'état de la connexion est défini sur Active sur la page Connexions.

Accorder une nouvelle autorisation pour le code d'autorisation

Si vous utilisez le type d'authentification Authorization code et que vous avez modifié la configuration du hub d'API Apigee, vous devez autoriser à nouveau votre connexion au hub d'API Apigee. Pour autoriser à nouveau une connexion, procédez comme suit :

  1. Sur la page Connexions, cliquez sur la connexion requise.

    La page de détails de la connexion s'ouvre.

  2. Cliquez sur Modifier pour modifier les détails de la connexion.
  3. Dans la section Authentification, vérifiez les détails du code d'autorisation OAuth 2.0.

    Apportez des modifications, si besoin.

  4. Cliquez sur Enregistrer. La page des détails de la connexion s'affiche.
  5. Dans la section Authentification, cliquez sur Modifier l'autorisation. Le volet Autoriser s'affiche.
  6. Cliquez sur Autoriser.

    Si l'autorisation aboutit, l'état de la connexion est défini sur Active sur la page Connexions.

Limites du système

Le connecteur Apigee API Hub peut traiter au maximum 20 transactions par seconde et par nœud, et limite les transactions au-delà de ce seuil. Par défaut, Integration Connectors alloue deux nœuds (pour améliorer la disponibilité) à une connexion.

Pour en savoir plus sur les limites applicables à Integration Connectors, consultez Limites.

Utiliser la connexion au hub d'API Apigee dans une intégration

Une fois la connexion créée, elle devient disponible dans Application Integration. Vous pouvez utiliser la connexion dans une intégration au moyen de la tâche "Connecteurs".

Actions

Ce connecteur fournit une couche d'abstraction pour les objets du service de backend connecté. Vous ne pouvez accéder aux objets du backend que par le biais de cette abstraction. L'abstraction vous est présentée sous forme d'actions. Une Action est une fonction de première classe mise à la disposition de l'intégration au moyen de l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste Actions est vide.

Problèmes connus

Le connecteur du hub d'API Apigee est soumis à des limites de configuration. Les ressources pouvant faire l'objet d'une recherche sont limitées à 2,5 Mo, et les fichiers de spécification d'API à 10 Mo. Pour en savoir plus, consultez Limites du hub d'API Apigee.

Demander de l'aide à la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étapes suivantes