Cette page a été traduite par l'API Cloud Translation.

Shopify

Le connecteur Shopify vous permet d'effectuer des opérations d'insertion, de suppression, de mise à jour et de lecture sur Shopify.

Versions compatibles

Ce connecteur modélise les API Shopify Admin en tant que base de données relationnelle.

Avant de commencer

Avant d'utiliser le connecteur Shopify, effectuez les tâches suivantes :

Dans votre projet Google Cloud :
- Accorder à l'utilisateur le rôle IAM roles/connectors.admin configuration du connecteur.
- Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  Un compte de service est un compte Google spécial destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez la section Créer un compte de service.
- Activez les services suivants :
  - secretmanager.googleapis.com (API Secret Manager)
  - connectors.googleapis.com (API Connectors)
  Pour savoir comment activer des services, consultez la page Activer des services.
Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.

Configurer le connecteur

Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à 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 :

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 + CRÉER pour ouvrir la page Créer une connexion.
Dans la section Emplacement, choisissez l'emplacement de la connexion.
1. Région : sélectionnez un emplacement dans la liste déroulante.
  Pour obtenir la liste de toutes les régions disponibles, consultez la page Emplacements.
2. Cliquez sur NEXT (Suivant).
Dans la section Informations de connexion, procédez comme suit :
1. Connecteur : sélectionnez Shopify 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 connexion, saisissez un nom pour l'instance de 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 l'instance de connexion.
5. Compte de service : sélectionnez un compte de service disposant des rôles requis.
6. 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.
7. ID d'application : ID d'application pour l'API Admin.
8. Nombre maximal de points par appel : indique le nombre de points facturés pour un appel.
9. Schéma : indiquez la version du serveur Shopify auquel vous souhaitez vous connecter.
10. Utiliser un proxy : cochez cette case pour configurer un serveur proxy pour la connexion, et spécifiez les valeurs suivantes :
11. Vous pouvez également cliquer sur + AJOUTER UN LIBELLÉ pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
12. Cliquez sur NEXT (Suivant).
Dans la section Destinations, saisissez les informations concernant l'hôte distant (système backend) auquel vous souhaitez vous connecter.
1. Type de destination : sélectionnez un type de destination.
  - Sélectionnez Adresse hôte dans la liste pour spécifier le nom d'hôte ou l'adresse IP de la destination.
  - Si vous souhaitez établir une connexion privée à vos systèmes backend, sélectionnez Rattachement du point de terminaison dans la liste, puis sélectionnez le rattachement du point de terminaison requis dans la liste Rattachement du point de terminaison.
    Remarque : Pour savoir comment créer un rattachement du point de terminaison, consultez Rattachement de service PSC et Rattachement du point de terminaison. Une fois le rattachement du point de terminaison créé, il apparaît dans la liste Rattachement du point de terminaison.
  Si vous souhaitez établir une connexion publique à vos systèmes backend avec une sécurité supplémentaire, vous pouvez envisager de configurer des adresses IP sortantes statiques pour vos connexions, puis de configurer vos règles de pare-feu pour ajouter à la liste d'autorisation uniquement les adresses IP statiques spécifiques.
  
  Pour saisir d'autres destinations, cliquez sur + AJOUTER UNE DESTINATION.
2. Cliquez sur NEXT (Suivant).
Dans la section Authentification, saisissez les informations d'authentification.
1. La connexion Shopify ne nécessite aucune authentification.
2. Cliquez sur NEXT (Suivant).
Vérifiez vos informations de connexion et d'authentification.
Cliquez sur Créer.

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que via cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connecté. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, dans un connecteur de serveur de fichiers, les dossiers sont les entités et, dans un connecteur de système de messagerie, les files d'attente sont les entités.
Toutefois, il est possible qu'un connecteur ne soit pas compatible ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.
Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Vous pouvez effectuer l'une des opérations suivantes sur une entité :
- Liste
- Obtenir
- Créer
- Mettre à jour
- Supprimer
La sélection d'une entité dans la liste disponible génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche de connecteur. Toutefois, si un connecteur n'accepte aucune des opérations d'entité, d'opérations ne sont pas répertoriées dans la liste Operations.
Action : une action est une fonction de première classe mise à la disposition de l'intégration via l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et une sortie . Toutefois, il est possible qu'un connecteur ne prenne en charge aucune action, auquel cas la liste Actions est vide.

Exemples d'opérations sur les entités

Exemple - Lister tous les produits

Cet exemple répertorie tous les enregistrements de l'entité Products.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Products dans la liste Entity.
Sélectionnez l'opération List, puis cliquez sur OK.

Exemple : Obtenir des informations sur les clients

Dans cet exemple, les informations du client spécifié sont récupérées Entité Customers.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Customers dans la liste Entity.
Sélectionnez l'opération Get, puis cliquez sur OK.
Saisissez l'ID d'entité du client dont vous souhaitez récupérer les informations.
Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId, puis saisissez 365009521884E12 dans le champ Default Value (Valeur par défaut).

Exemple : Supprimer un enregistrement de commande

Dans cet exemple, la commande spécifiée est supprimée Entité Order.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Order dans la liste Entity.
Sélectionnez l'opération Delete, puis cliquez sur OK.
Saisissez l'ID d'entité de la commande que vous souhaitez supprimer.
Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId, puis saisissez 475009571483E15 dans le champ Default Value (Valeur par défaut).

Exemple : Ajouter un client

Cet exemple ajoute le client spécifié à l'entité Customer.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Customer dans la liste Entity.
Sélectionnez l'opération Create, puis cliquez sur OK.
Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à celle-ci dans la section Champ Default Value:
```
{
"FirstName": "Test",
"LastName": "Customer5"
}
```
L'exécution de cet exemple renvoie une réponse semblable à la suivante : dans la variable de sortie connectorOutputPayload de votre tâche de connecteur:
```
{
"Id": 6448083206296
}
```

Exemple – Créer un enregistrement dans DiscountCode

Cet exemple crée un enregistrement dans l'entité DiscountCode.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez DiscountCode dans la liste Entity.
Sélectionnez l'opération Create, puis cliquez sur OK.
Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez semblable à celle-ci dans le champ Default Value:
```
{
"PriceRuleId": 1.394097291568E12,
"Code": "FREESHIP2025798"
}
```
L'exécution de cet exemple renvoie une réponse semblable à celle dans la variable de sortie connectorOutputPayload de votre tâche de connecteur:
```
{
"Id": 1.97836790828E13,
"PriceRuleId": null
}
```

Exemple – Créer un enregistrement dans "Pricerule"

Cet exemple crée un enregistrement dans l'entité Pricerule.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Pricerule dans la liste Entity.
Sélectionnez l'opération Create, puis cliquez sur OK.
Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à celle-ci dans la section Champ Default Value:
```
{
"Id": 7.13459564696E11,
"AllocationMethod": "each",
"CustomerSelection": "all",
"TargetType": "line_item",
"UsageLimit": 100.0,
"Title": "DP_PriceRule"
}
```
L'exécution de cet exemple renvoie une réponse semblable à la suivante : dans la variable de sortie connectorOutputPayload de votre tâche de connecteur:
```
{
"Id": 197836790834,
"PriceRuleId": null
}
```

Exemple – Créer un enregistrement dans ProductVariant

Cet exemple crée un enregistrement dans l'entité ProductVariant.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez ProductVariant dans la liste Entity.
Sélectionnez l'opération Create, puis cliquez sur OK.

Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à celle-ci dans la section Champ Default Value:

{
"Id": 1070325065,
"ProductId": 7652181016728,
"ImageId": null,
"Price": 1,
"CompareAtPrice": null,
"Title": "Yellow",
"Barcode": null,
"FulfillmentService": "manual",
"InventoryManagement": "shopify",
"InventoryPolicy": "deny",
"InventoryQuantity": 1070325069,
"Option1": "Yellow",
"Option2": null,
"Option3": null,
"Position": 5,
"Sku": "",
"Taxable": true
}

L'exécution de cet exemple renvoie une réponse semblable à la suivante dans votre connecteur. la variable de sortie connectorOutputPayload de la tâche:

{
"Id": 42711984373912
}

Exemple : Mettre à jour les informations sur le client

Cet exemple met à jour les détails du client spécifié dans l'entité Customer.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Customer dans la liste Entity.
Sélectionnez l'opération Update, puis cliquez sur OK.
Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à celle-ci dans la section Champ Default Value:
```
{
"FirstName": "Test",
"LastName": "Customer2"
}
```
Saisissez l'ID d'entité du client que vous souhaitez supprimer.
Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId, puis saisissez 648400653532 dans le champ Default Value (Valeur par défaut).

Au lieu de spécifier entityId, vous pouvez également définir le filterClause sur 648400653532.

L'exécution de cet exemple renvoie une réponse semblable à la suivante dans votre connecteur. la variable de sortie connectorOutputPayload de la tâche:
```
{
"Id": 648400653532
}
```

Exemple – Mettre à jour un enregistrement dans ProductVariant

Cet exemple met à jour un enregistrement dans l'entité ProductVariant.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez ProductVariant dans la liste Entity.
Sélectionnez l'opération Update, puis cliquez sur OK.

{
"ProductId": 7.652181016728E12,
"ImageId": null,
"Price": 200.0,
"CompareAtPrice": null,
"Title": "Yellow Updated",
"Barcode": null,
"FulfillmentService": "manual",
"InventoryManagement": "shopify",
"InventoryQuantity": 1.070325069E9,
"Option1": "Yellow new",
"Option2": null,
"Option3": null,
"Position": 5.0,
"Sku": "",
"Taxable": true
}

Spécifiez l'ID d'entité de l'enregistrement à mettre à jour.
Pour définir l'ID d'entité, Cliquez sur entityId, puis saisissez 34601602744472 dans le champ Valeur par défaut. .

L'exécution de cet exemple renvoie une réponse semblable à la suivante dans votre connecteur. la variable de sortie connectorOutputPayload de la tâche:
```
{
"Id": 2484258073471
}
```

Utiliser Terraform pour créer des connexions

Vous pouvez utiliser l'outil Terraform ressource pour créer une connexion.

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base.

Pour afficher un exemple de modèle Terraform pour la création de connexions, consultez cet exemple de modèle.

Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform:

Nom du paramètre	Type de données	Requis	Description
max_points_per_call	STRING	Faux	Spécifie le nombre de points d'un appel.
schema_v23	ENUM	Faux	Spécifiez la version du serveur Shopify à laquelle vous connecter. Valeurs acceptées: REST-2023-04, REST-2023-07, GRAPHQL-2023-04, GRAPHQL-2023-07
proxy_enabled	VALEUR BOOLÉENNE	Faux	Cochez cette case pour configurer un serveur proxy pour la connexion.
proxy_auth_scheme	ENUM	Faux	Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Les valeurs acceptées sont: BASIC, DIGEST, NONE
proxy_user	STRING	Faux	Nom d'utilisateur permettant de s'authentifier auprès du proxy ProxyServer.
proxy_password	SECRET	Faux	Mot de passe à utiliser pour l'authentification auprès du proxy ProxyServer.
proxy_ssltype	ENUM	Faux	Type SSL à utiliser lors de la connexion au proxy ProxyServer. Les valeurs acceptées sont: AUTO, ALWAYS, NEVER et TUNNEL.

Utiliser la connexion Shopify dans une intégration

Une fois la connexion créée, elle devient disponible à la fois Apigee Integration et Application Integration. Vous pouvez utiliser la connexion lors d'une intégration via la tâche "Connecteurs".

Pour comprendre comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez la section Tâche Connecteurs.
Pour découvrir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez la section Tâche Connecteurs.

Obtenir de l'aide auprès de la communauté Google Cloud

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

Étape suivante

Découvrez comment suspendre et réactiver une connexion.
Découvrez comment surveiller l'utilisation des connecteurs.
Découvrez comment afficher les journaux du connecteur.