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 :
    • 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.
    • 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 type spécial de compte Google 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 en savoir plus, consultez 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 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.

Configurer le connecteur

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 Connecteurs d'intégration > 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, 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 Emplacements.

    2. Cliquez sur SUIVANT.
  4. Dans la section Détails 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, indiquez le nom de l'instance de connexion.

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

      • Ils peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Ils doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Ils ne peuvent 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 des 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 améliorer la disponibilité) et le nombre maximal de nœuds sur 50.

    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. (Facultatif) Dans la section Paramètres avancés, cochez la case Utiliser un proxy pour configurer un serveur proxy pour la connexion et configurez les valeurs suivantes :
      • Schéma d'authentification du proxy : sélectionnez le type d'authentification pour l'authentification auprès du serveur proxy. Les types d'authentification suivants sont compatibles :
        • De base : authentification HTTP de base.
        • Digest : authentification HTTP Digest.
      • Utilisateur du proxy : nom d'utilisateur permettant de s'authentifier auprès du serveur proxy.
      • Mot de passe du proxy : secret Secret Manager du mot de passe de l'utilisateur.
      • Type SSL du proxy : type SSL à utiliser pour se connecter au serveur proxy. Les types d'authentification suivants sont compatibles :
        • Auto : paramètre par défaut. Dans le cas d'une URL HTTPS, l'option "Tunnel" est utilisée. Dans le cas d'une URL HTTP, l'option "Jamais" est utilisée.
        • Toujours : le protocole SSL est toujours activé pour la connexion.
        • Jamais : le protocole SSL n'est pas activé pour la connexion.
        • Tunnel : la connexion s'effectue avec un proxy de tunnelisation. Le serveur proxy ouvre une connexion à l'hôte distant et le trafic transite par le proxy.
      • Dans la section Serveur proxy, saisissez les détails du serveur proxy.
        1. Cliquez sur + Ajouter une destination.
        2. Sélectionnez un type de destination.
          • Adresse de l'hôte : spécifiez le nom d'hôte ou l'adresse IP de la destination.

            Si vous souhaitez établir une connexion privée à votre système backend, procédez comme suit :

    11. (Facultatif) Cliquez sur + AJOUTER UNE ÉTIQUETTE pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
    12. 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. Type de destination : sélectionnez un type de destination.
      • Pour spécifier le nom d'hôte ou l'adresse IP de la destination, sélectionnez Adresse de l'hôte, puis saisissez l'adresse dans le champ Hôte 1.
      • Pour établir une connexion privée, sélectionnez Rattachement de point de terminaison, puis choisissez le rattachement requis dans la liste Rattachement de 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 SUIVANT.
  6. Dans la section Authentification, spécifiez les détails du jeton d'accès.
  7. Cliquez sur SUIVANT.
  8. Vérifier : vérifiez vos informations de connexion et d'authentification.
  9. Cliquez sur Créer.

Créer un jeton d'accès et des identifiants d'API

  1. Connectez-vous au compte Shopify.
  2. Dans le portail des développeurs Shopify, cliquez sur Settings (Paramètres).
  3. Sélectionnez Apps and sales channels > Develop apps (Applications et canaux de vente > Développer des applications).
  4. Cliquez sur Create an app (Créer une application).
  5. Dans la boîte de dialogue qui s'affiche, saisissez le nom de votre application, puis cliquez sur Create (Créer).
  6. Sur la page Overview (Présentation), cliquez sur Configure Admin API scopes (Configurer les champs d'application de l'API Admin), puis sélectionnez les autorisations d'accès pour votre application.
  7. Cliquez sur Enregistrer.
  8. Sur la page API Credentials (Identifiants de l'API), sélectionnez Install app (Installer l'application).
  9. Dans la boîte de dialogue qui s'affiche, cliquez sur Install (Installer).
  10. Sur la page API Credentials (Identifiants de l'API), sélectionnez Reveal token once (Afficher le jeton une fois) et copiez le jeton d'accès administrateur de l'API. Vous l'utiliserez ultérieurement lorsque vous configurerez l'authentification pour la connexion.
  11. Dans les champs API key (Clé API) et API secret key (Clé secrète API), copiez les clés pour les utiliser ultérieurement lorsque vous configurerez l'authentification pour la connexion.

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 par le biais de 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és. 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, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.

    Toutefois, il est possible qu'un connecteur n'accepte 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é. Voici les opérations possibles :

    Lorsque vous sélectionnez une entité dans la liste proposée, cela 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 "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste Operations.

  • Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de 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 un paramètre de sortie. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste Actions est vide.

Exemples d'opérations d'entité

Exemple : Lister tous les produits

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

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

Exemple : Obtenir les détails du client

Cet exemple obtient les détails du client spécifié à partir de l'entité Customers.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Customers dans la liste Entity.
  3. Sélectionnez l'opération Get, puis cliquez sur OK.
  4. Saisissez l'ID d'entité du client dont vous souhaitez récupérer les détails.

    Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 365009521884E12 dans le champ Valeur par défaut.

Exemple : Supprimer un enregistrement de commande

Cet exemple supprime la commande spécifiée de l'entité Order.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Order dans la liste Entity.
  3. Sélectionnez l'opération Delete, puis cliquez sur OK.
  4. Saisissez l'ID d'entité de la commande que vous souhaitez supprimer.

    Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 475009571483E15 dans le champ Valeur par défaut.

Exemple : Ajouter un client

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

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Customer dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le 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.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez DiscountCode dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
    "PriceRuleId": 1.394097291568E12,
    "Code": "FREESHIP2025798"
    }

    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": 1.97836790828E13,
    "PriceRuleId": null
    }

Exemple : Créer un enregistrement dans Pricerule

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

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Pricerule dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le 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.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez ProductVariant dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le 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 la variable de sortie connectorOutputPayload de votre tâche de connecteur :

    {
    "Id": 42711984373912
    }

Exemple : Mettre à jour les détails du client

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

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Customer dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
    "FirstName": "Test",
    "LastName": "Customer2"
    }
  5. Saisissez l'ID d'entité du client que vous souhaitez supprimer.

    Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 648400653532 dans le champ Valeur par défaut.

    Sinon, au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 648400653532.

    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": 648400653532
    }

Exemple : Mettre à jour un enregistrement dans ProductVariant

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

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez ProductVariant dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
    "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
    }
  5. 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 la variable de sortie connectorOutputPayload de votre tâche de connecteur :

    {
    "Id": 2484258073471
    }

Créer des connexions à l'aide de Terraform

Vous pouvez utiliser la ressource Terraform pour créer une connexion.

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

Pour afficher un exemple de modèle Terraform permettant de créer une connexion, consultez 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 Obligatoire Description
max_points_per_call STRING False Indique le nombre de points facturés pour un appel.
schema_v23 ENUM False Indiquez la version du serveur Shopify auquel vous souhaitez vous connecter. Valeurs acceptées : REST-2023-04, REST-2023-07, GRAPHQL-2023-04 et GRAPHQL-2023-07.
proxy_enabled BOOLEAN False Cochez cette case afin de configurer un serveur proxy pour la connexion.
proxy_auth_scheme ENUM False Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Valeurs acceptées : BASIC, DIGEST et NONE.
proxy_user STRING False Nom d'utilisateur permettant de s'authentifier auprès du proxy ProxyServer.
proxy_password SECRET False Mot de passe à utiliser pour s'authentifier auprès du proxy ProxyServer.
proxy_ssltype ENUM False Type SSL à utiliser pour se connecter au proxy ProxyServer. Valeurs acceptées : AUTO, ALWAYS, NEVER et TUNNEL.

Utiliser la connexion Shopify dans une intégration

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

  • Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez Tâche "Connecteurs".
  • Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez Tâche "Connecteurs".

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