Consultez la liste des connecteurs compatibles avec Application Integration.

Créer un connecteur personnalisé

Preview

Ce produit ou cette fonctionnalité est soumis aux "Conditions des offres de pré-DG" dans la section "Conditions d'utilisation générales" des Conditions spécifiques au service. Les produits et fonctionnalités pré-DG sont disponibles "en l'état" et peuvent bénéficier d'une assistance limitée. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Cette page explique comment créer un connecteur personnalisé. Pour comprendre ce qu'est un connecteur personnalisé, consultez l'article Connecteurs personnalisés.

Remarque : Un connecteur personnalisé est une ressource globale. Une fois créé, vous pouvez donc l'utiliser n'importe quel emplacement compatible avec Application Integration.

Pour établir la connectivité à votre backend à l'aide d'un connecteur personnalisé, vous devez effectuer les tâches suivantes:

1. Créer un connecteur personnalisé : dans cette tâche, vous allez définir le contrat entre Application Integration et votre point de terminaison (backend) en fournissant la spécification OpenAPI du point de terminaison. Actuellement, seule la version 3.0 d'OpenAPI et toutes ses versions mineures sont compatibles. La spécification de la spécification est une activité ponctuelle.
2. Créer une connexion de connecteur personnalisée : dans cette tâche, vous allez configurer les détails de connexion du backend, tels que le nom d'hôte et l'authentification. Pour un connecteur personnalisé spécifique, vous pouvez créer autant de connexions que nécessaire.

Pour comprendre la différence entre un connecteur et une connexion, consultez l'article Connecteur et connexion.

Avant de commencer

Assurez-vous que l'utilisateur qui crée le connecteur personnalisé possède l'un des rôles IAM suivants:

• Administrateur de connecteurs personnalisés
• Administrateur Connectors

Créer un connecteur personnalisé

Comme décrit dans les scénarios de connectivité backend, les connecteurs personnalisés peuvent présenter l'un des modèles de connectivité suivants:

• Connectivité directe au point de terminaison public de votre backend.
• Connectivité indirecte à votre backend via un point de terminaison public intermédiaire.

Les étapes de création d'un connecteur personnalisé varient légèrement pour ces deux modèles.

Créer un connecteur personnalisé avec connectivité directe

Pour créer un connecteur personnalisé avec une connectivité directe au point de terminaison de votre backend, procédez comme suit:

Console

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

   Accéder à la page "Connecteurs personnalisés"

2. Cliquez sur Créer pour ouvrir la page Créer un connecteur personnalisé.
3. Dans la section Informations sur le connecteur, définissez les champs suivants :
   1. Nom du connecteur: saisissez le nom du connecteur.
   2. Nom à afficher: saisissez un nom à afficher pour le connecteur.
   3. Description : saisissez une description.
   4. Compte de service: sélectionnez un compte de service disposant des rôles requis.
   5. Logo: importez l'image dans un bucket Cloud Storage afin de l'utiliser comme logo du connecteur.
      Remarque : Assurez-vous que le contrôle des accès ultraprécis est activé sur votre bucket Cloud Storage et que la protection contre l'accès public est désactivée.
4. Cliquez sur Suivant.
5. Dans la section Spécification des connecteurs, définissez les champs suivants :
   1. Type de connecteur personnalisé: sélectionnez le type de connecteur personnalisé.
   2. Spécification du connecteur: saisissez l'URL publique de votre spécification OpenAPI ou importez votre fichier de spécification dans un bucket Cloud Storage.
6. Vérifiez les informations de configuration du connecteur, puis cliquez sur Créer.

Si le connecteur a été créé, il apparaît sur la page Accéder à la page Connecteurs personnalisés. S'il s'agit d'un nouveau connecteur, une première version du connecteur est également créée. Vous pouvez consulter les détails de cette version dans l'onglet Version de la page Détails du connecteur personnalisé. Pour en savoir plus, consultez .

Notez toutefois que pour vous connecter à votre backend, vous devez créer une connexion pour le connecteur que vous venez de créer. Pour en savoir plus, consultez la section Créer une connexion de connecteur personnalisée.

API

Les exemples de commandes suivants montrent comment créer un connecteur personnalisé à l'aide des API Application Integration:

1. Créez le connecteur.

   curl -X POST \
   -H "authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json"
   -d '{"customConnectorType":"OPEN_API", \
   "displayName":"CUSTOM_CONNECTOR_NAME", \
   "description": "an open api based custom connector for hrms"}' \
   "https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors?custom_connector_id=UNIQUE_IDENTIFIER"
   

   Remplacez les éléments suivants :

   • CUSTOM_CONNECTOR_NAME: nom du connecteur personnalisé.
   • PROJECT_ID : ID de votre projet Google Cloud.
   • UNIQUE_IDENTIFIER: identifiant unique du connecteur. Par exemple, custom-connector-1.
2. Configurez la version du connecteur personnalisé.

   curl -X POST \
   -H "authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   -d '{"spec_location": "SPECIFICATION_URL",}' \
   "https://connectors.googleapis.comv1/projects/PROJECT_ID/locations/global/customConnectors/openapi-customconnector/customConnectorVersions?custom_connector_version_id=VERSION_NUMBER"
   

Remplacez les éléments suivants :

• SPECIFICATION_URL: URL de spécification OpenAPI. Exemple : https://petstore3.swagger.io/api/v3/openapi.json.
• PROJECT_ID : ID de votre projet Google Cloud.
• VERSION_NUMBER: numéro de version du connecteur Exemple :2

Créer un connecteur personnalisé avec connectivité indirecte

Pour créer un connecteur personnalisé qui se connecte à votre backend via un point de terminaison intermédiaire, procédez comme suit:

Console

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

   Accéder à la page "Connecteurs personnalisés"

2. Cliquez sur Créer pour ouvrir la page Créer un connecteur personnalisé.
3. Dans la section Informations sur le connecteur, définissez les champs suivants :
   1. Nom du connecteur: saisissez le nom du connecteur.
   2. Nom à afficher: saisissez un nom à afficher pour le connecteur.
   3. Description : saisissez une description.
   4. Configurer la destination du connecteur pour l'accès au backend: activez cette option. Les sections de configuration supplémentaires de la page s'affichent.
   5. Compte de service: sélectionnez un compte de service disposant des rôles requis.
   6. Logo: importez l'image dans un bucket Cloud Storage afin de l'utiliser comme logo du connecteur.
      Remarque : Assurez-vous que le contrôle des accès ultraprécis est activé sur votre bucket Cloud Storage et que la protection contre l'accès public est désactivée.
4. Cliquez sur Suivant.
5. Dans la section Spécification des connecteurs, définissez les champs suivants :
   1. Type de connecteur personnalisé: sélectionnez le type de connecteur personnalisé.
   2. Spécification du connecteur: saisissez l'URL publique de votre spécification OpenAPI ou importez votre fichier de spécification dans un bucket Cloud Storage.
6. Cliquez sur Suivant.
7. Dans la section Destination du connecteur, définissez les champs suivants :
   1. Destination type (Type de destination) : sélectionnez Host address (Adresse de l'hôte).
   2. Host (Hôte) : saisissez le nom d'hôte sur lequel votre service intermédiaire s'exécute.
   3. Port: saisissez le numéro de port de votre service intermédiaire.
8. Cliquez sur Suivant.
9. Dans la section Authentification du connecteur, sélectionnez le type d'authentification du service intermédiaire, puis saisissez les informations correspondantes lorsque vous y êtes invité. Cette étape consiste à configurer l'authentification depuis Application Integration vers le service intermédiaire.

   La configuration de l'authentification entre le service intermédiaire et le backend ne peut pas être configurée dans Application Integration. C'est au service intermédiaire de déterminer comment s'authentifier auprès du backend.

10. Cliquez sur Suivant.
11. Dans la section Variables de backend, saisissez les valeurs que vous souhaitez envoyer à votre backend via le service intermédiaire. Vous devez configurer les valeurs en tant que paires clé-valeur. Pour saisir une paire clé-valeur, cliquez sur Ajouter une variable, puis définissez les champs suivants :
    • Clé: saisissez le nom de la clé.
    • Type de valeur: sélectionnez le type de données de la variable.
    • Nom à afficher: saisissez un nom à afficher.
    • Emplacement: indiquez la manière dont vous souhaitez que le connecteur envoie les variables au service intermédiaire. Les options disponibles sont Header, Request payload et Query parameter.
    • Vous pouvez également sélectionner Required pour spécifier que la variable est une variable obligatoire.
    Remarque : Vous serez invité à saisir les valeurs des variables configurées lors de la création d'une connexion.
12. Cliquez sur Suivant.
13. Vérifiez les informations de configuration du connecteur, puis cliquez sur Créer.

Lorsque le connecteur est créé, il apparaît sur la page Connecteurs personnalisés. S'il s'agit d'un nouveau connecteur, une première version du connecteur est également créée. Vous pouvez consulter les détails de cette version dans l'onglet Version de la page Détails du connecteur personnalisé. Pour plus d'informations sur la création et la modification d'une version de connecteur personnalisée, consultez la page Gérer les versions d'un connecteur personnalisé.

Notez toutefois que pour vous connecter à votre backend, vous devez créer une connexion pour le connecteur que vous venez de créer. Pour en savoir plus, consultez la section Créer une connexion de connecteur personnalisée.

API

Les exemples de commandes suivants montrent comment créer un connecteur personnalisé à l'aide des API Application Integration:

1. Créez le connecteur.

   curl -X POST \
   -H "authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json"
   -d '{"customConnectorType":"OPEN_API", \
   "displayName":"CUSTOM_CONNECTOR_NAME", \
   "description": "an open api based custom connector for hrms"}' \
   "https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors?custom_connector_id=UNIQUE_IDENTIFIER"
   

   Remplacez les éléments suivants :

   • CUSTOM_CONNECTOR_NAME: nom du connecteur personnalisé.
   • PROJECT_ID : ID de votre projet Google Cloud.
   • UNIQUE_IDENTIFIER: identifiant unique du connecteur. Par exemple, custom-connector-1.
2. Configurez la version du connecteur personnalisé et l'authentification.

   curl -X POST \
   -H "authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   -d '{"spec_location": "SPECIFICATION_URL", \
   "service_account":"test-sa", \
   "enable_backend_destination_config": true, \
   "auth_config": { \
   "auth_type":"USER_PASSWORD", \
   "auth_key": "basic", \
   "user_password": { \
   "username":"USERNAME", \
   "password": {"secret_version":"projects/PROJECT_ID/secrets/fidelity-secret/versions/SECRET_VERSION_NUMBER"} \
   }}, \
   "backend_variable_templates": [{ \
   "key":"authkey", \
   "value_type":"SECRET", \
   "display_name":"Authorization Key", \
   "required":true, \
   "location_type": "HEADER" \
   }], \
   "destination_configs":[{ \
   "key":"base_url", \
   "destinations": [{ \
   "host":"DESTINATION_HOST_ADDRESS" \
   }]} \
   ]}' \
   "https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors/facade-connector/customConnectorVersions?custom_connector_version_id=CONNECTOR_VERSION_NUMBER"
   

Remplacez les éléments suivants :

• SPECIFICATION_URL: URL de spécification OpenAPI. Exemple : https://petstore3.swagger.io/api/v3/openapi.json.
• PROJECT_ID : ID de votre projet Google Cloud.
• USERNAME: nom d'utilisateur pour l'authentification auprès du service intermédiaire.
• SECRET_VERSION_NUMBER: numéro de version du secret Secret Manager Exemple :2
• DESTINATION_HOST_ADDRESS: adresse hôte du service intermédiaire. Exemple :http://www.test.com:80
• CONNECTOR_VERSION_NUMBER: numéro de version du connecteur personnalisé. Exemple :1
Remarque : Cet exemple d'appel d'API utilise l'authentification Username and Password. En fonction de vos besoins, vous pouvez utiliser un autre type d'authentification.

Créer une connexion de connecteur personnalisée

Après avoir créé votre connecteur personnalisé, vous devez créer une connexion du type de connecteur personnalisé pour vous connecter à votre backend. Pour créer une connexion, procédez comme suit:

1. Cliquez sur Créer pour ouvrir la page Créer une connexion.
2. Dans la section Emplacement, sélectionnez un emplacement pour la connexion dans le champ Région.

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

3. Cliquez sur Suivant.
4. Dans la section Détails de la connexion, définissez les champs suivants :
   1. Connecteur: sélectionnez votre connecteur personnalisé dans la liste déroulante des connecteurs disponibles.
   2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
   3. Dans le champ Nom de la connexion, saisissez un nom pour la connexion.

      Les noms de connexion doivent répondre aux critères suivants :

      • Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Les noms de connexion ne peuvent pas dépasser 63 caractères.
   4. Saisissez éventuellement une description de la connexion.
   5. Vous pouvez également sélectionner Activer Cloud Logging pour activer Cloud Logging.
   6. Compte de service: sélectionnez un compte de service disposant des rôles requis.
   7. Vous pouvez également configurer les paramètres du nœud 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 plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez la section 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.

   Remarque : Vous ne pouvez personnaliser les valeurs du nœud de connexion que si vous êtes un client facturé à l'usage.
   8. Vous pouvez également cliquer sur Ajouter une étiquette pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
5. Cliquez sur Suivant.
6. Dans la section Authentification, saisissez les informations d'authentification de votre backend.
   • Si vous vous connectez directement à votre backend, Application Integration vous invite à configurer l'authentification pour votre backend.
   • Si vous vous connectez indirectement à votre backend via un service intermédiaire, Application Integration ne vous invite pas à configurer les informations d'authentification. Lors de la création du connecteur, vous auriez déjà configuré l'authentification entre Application Integration et le service intermédiaire. Avec Application Integration, vous n'avez pas besoin de configurer l'authentification entre le service intermédiaire et le backend. Le choix du service intermédiaire est de déterminer la manière dont il souhaite s'authentifier auprès du backend.
7. Cliquez sur Suivant.
8. Vérifiez les détails de la configuration de la connexion, puis cliquez sur Créer.

Si la connexion aboutit, elle est répertoriée sur la page Toutes les connexions et la connexion devient disponible dans Application Integration. Vous pouvez utiliser la connexion dans votre intégration via la tâche Connecteurs.

Remarques

Tenez compte des points suivants lorsque vous créez un connecteur personnalisé:

• Application Integration n'accepte que la version 3.0 d'OpenAPI et toutes ses versions mineures.
• La spécification OpenAPI n'est pas validée lors de la création du connecteur personnalisé. Lorsque vous créez une connexion pour le connecteur personnalisé, Application Integration valide la spécification. Si elle comporte des erreurs, la connexion est à l'état Error.
• Application Integration ne fait pas de distinction entre les entités et les actions. Par conséquent, les entités et les actions de votre backend seront listées en tant que Actions dans votre connecteur personnalisé.
• Les connecteurs personnalisés ne sont pas acceptés dans les projets Google Cloud pour lesquels VPC Service Controls est activé.
• Le point de terminaison de la spécification OpenAPI et le point de terminaison du backend doivent être accessibles publiquement. Cela signifie que vous ne pouvez pas établir de connectivité privée à votre backend.
• Le type de média en plusieurs parties n'est pas compatible avec la spécification OpenAPI.
• Vous ne pouvez pas modifier les détails de version d'un connecteur personnalisé.