Créer un connecteur personnalisé

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

Pour établir la connectivité à votre backend à l'aide d'un connecteur personnalisé, procédez comme suit:

Créer un connecteur personnalisé : dans cette tâche, vous allez définir le contrat entre Integration Connectors et votre point de terminaison (backend) en fournissant la spécification OpenAPI correspondante. 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.
Créer une connexion de connecteur personnalisée : dans cette tâche, vous allez configurer les informations de connexion de votre backend, telles que le nom d'hôte et l'authentification. Pour un connecteur personnalisé spécifique, vous pouvez créer autant de connexions que vous le souhaitez.

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:

Créer un connecteur personnalisé

Comme décrit dans les scénarios de connectivité au 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 formats.

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

Dans la console, accédez à la page Connecteurs d'intégration > Connecteurs personnalisés, puis sélectionnez ou créez un projet Google Cloud.
Accéder à la page "Connecteurs personnalisés"
Cliquez sur Créer pour ouvrir la page Créer un connecteur personnalisé.
Dans la section Détails du connecteur, définissez les champs suivants :
1. Nom du connecteur: saisissez un nom pour le connecteur.
2. Nom à afficher: saisissez un nom à afficher pour le connecteur.
3. Description : saisissez une description.
4. Type de connecteur personnalisé: sélectionnez le type de connecteur personnalisé.
5. Compte de service: sélectionnez un compte de service disposant des rôles requis.
Cliquez sur Suivant.
Dans la section Spécification du connecteur, saisissez l'URL de la spécification OpenAPI de votre backend dans le champ URL de spécification, puis cliquez sur Suivant. Exemple :https://petstore3.swagger.io/api/v3/openapi.json
Remarque : L'URL de la spécification OpenAPI doit être accessible publiquement.
Vérifiez les détails de la configuration du connecteur, puis cliquez sur Créer.

Si le connecteur a bien été créé, le nouveau connecteur s'affiche sur la page Accéder à la page "Connecteurs personnalisés". Toutefois, notez 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 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 Integration Connectors:

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.

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. Par 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

Dans la console, accédez à la page Connecteurs d'intégration > Connecteurs personnalisés, puis sélectionnez ou créez un projet Google Cloud.
Accéder à la page "Connecteurs personnalisés"
Cliquez sur Créer pour ouvrir la page Créer un connecteur personnalisé.
Dans la section Détails du connecteur, définissez les champs suivants :
1. Nom du connecteur: saisissez un nom pour le connecteur.
2. Nom à afficher: saisissez un nom à afficher pour le connecteur.
3. Description : saisissez une description.
4. Type de connecteur personnalisé: sélectionnez le type de connecteur personnalisé.
5. Compte de service: sélectionnez un compte de service disposant des rôles requis.
Cliquez sur Suivant.
Dans la section Spécification du connecteur, saisissez l'URL de la spécification OpenAPI de votre service intermédiaire dans le champ URL de spécification, puis sélectionnez l'option Configurer la destination du connecteur pour l'accès au backend.
Les sections de configuration supplémentaires de la page s'affichent alors.
Cliquez sur Suivant.
Dans la section Destination du connecteur, définissez les champs suivants :
1. Type de destination: sélectionnez Adresse de l'hôte.
2. Host (Hôte) : saisissez le nom d'hôte où votre service intermédiaire s'exécute.
3. Port: saisissez le numéro de port de votre service intermédiaire.
Cliquez sur Suivant.
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 entre Integration Connectors et le service intermédiaire.
La configuration de l'authentification du service intermédiaire vers le backend ne peut pas être configurée dans Integration Connectors. C'est au service intermédiaire de déterminer la manière dont il souhaite s'authentifier auprès du backend.
Cliquez sur Suivant.
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 :
- Key (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: spécifiez 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 qu'il s'agit d'une variable obligatoire.
Remarque : Vous serez invité à saisir les valeurs des variables configurées lors de la création d'une connexion.
Cliquez sur Suivant.
Vérifiez les détails de la configuration du connecteur, puis cliquez sur Créer.

API

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

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.

Configurez la version personnalisée du connecteur 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. Par exemple, 2.
DESTINATION_HOST_ADDRESS: adresse hôte du service intermédiaire. Par exemple, http://www.test.com:80.
CONNECTOR_VERSION_NUMBER: numéro de version du connecteur personnalisé Par 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 pouvoir vous connecter au backend. Voici les grandes étapes à suivre pour créer une connexion:

Dans la console Cloud, accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un projet Google Cloud.
Accéder à la page "Connexions"
Cliquez sur Create new (Créer) pour ouvrir la page Create connection (Créer une connexion).
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.
Cliquez sur Suivant.
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 le nom de 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 pour la connexion.
5. Vous pouvez également sélectionner Activer Cloud Logging pour l'activer.
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. Un plus grand nombre de nœuds est nécessaire afin de traiter plus de transactions pour une connexion. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre l'impact des nœuds sur 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.
8. Vous pouvez également cliquer sur Ajouter une étiquette pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
Cliquez sur Suivant.
Dans la section Authentification, saisissez les informations d'authentification de votre backend.
- Si vous vous connectez directement à votre backend, Integration Connectors vous invite à configurer l'authentification pour votre backend.
- Si vous vous connectez indirectement à votre backend via un service intermédiaire, Integration Connectors ne vous invite pas à configurer les informations d'authentification. Lors de la création du connecteur, vous devez avoir déjà configuré l'authentification entre Integration Connectors et le service intermédiaire. Avec Integration Connectors, vous n'avez pas besoin de configurer l'authentification entre le service intermédiaire et le backend. C'est au service intermédiaire de déterminer la manière dont il souhaite s'authentifier auprès du backend.
Cliquez sur Suivant.
Vérifiez les détails de la configuration de la connexion, puis cliquez sur Créer.

Si la connexion aboutit, elle apparaît 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é:

Integration Connectors n'est compatible qu'avec la version 3.0 d'OpenAPI et ses versions mineures.
La spécification OpenAPI n'est pas validée lors de la création d'un connecteur personnalisé. Lorsque vous créez une connexion pour le connecteur personnalisé, Integration Connectors valide la spécification. Si des erreurs se produisent, la connexion est à l'état Error.
Integration Connectors ne fait pas de différence entre les entités et les actions. Par conséquent, les entités et les actions de votre backend sont toutes deux répertoriées en tant que Actions dans votre connecteur personnalisé.
Les connecteurs personnalisés ne sont pas compatibles avec 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 avec votre backend.
Le type de média en plusieurs parties n'est pas compatible avec la spécification OpenAPI.
Actuellement, une fois que vous avez créé un connecteur personnalisé, vous ne pouvez pas modifier ses informations.