WooCommerce

Utilisez le connecteur WooCommerce pour effectuer des opérations d'insertion, de suppression, de mise à jour et de lecture dans WooCommerce.

Avant de commencer

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

• Dans votre projet Google Cloud :
  • 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 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 :

1. 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"

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 la page Emplacements.

   2. Cliquez sur NEXT (Suivant).
4. Dans la section Détails de connexion, procédez comme suit :
   1. Connecteur : sélectionnez WooCommerce 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 doivent pas dépasser 49 caractères.
   4. Saisissez éventuellement une Description pour l'instance de connexion.
   5. Vous pouvez également activer 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. 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. Utiliser un proxy : cochez cette case pour configurer un serveur proxy pour la connexion, et spécifiez 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 :
     • Basique : authentification HTTP de base.
     • Condensé : authentification HTTP par condensé.
   • Utilisateur du proxy : nom d'utilisateur à utiliser pour l'authentification 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 lors de la connexion 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 : la connexion SSL est toujours activée.
     • Jamais : la connexion n'est pas activée pour SSL.
     • Tunnel : la connexion s'effectue via 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 :

          • Créez un rattachement de service PSC.
          • Créez un rattachement de point de terminaison, puis saisissez les détails du rattachement de point de terminaison dans le champ Adresse de l'hôte.
   9. Vous pouvez également cliquer sur + AJOUTER UN LIBELLÉ pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
   10. Cliquez sur NEXT (Suivant).
5. 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.

   2. Cliquez sur SUIVANT.
6. Dans la section Authentification, saisissez les informations d'authentification.

   Pour comprendre comment configurer ces types d'authentification, consultez la section Configurer l'authentification.

7. Après avoir spécifié les informations d'authentification, cliquez sur SUIVANT.
8. Vérifiez vos informations de connexion et d'authentification.
9. Cliquez sur Créer.

Configurer l'authentification

Saisissez les informations d'authentification.

• Consumer Key: clé client attribuée par WooCommerce lors de la création des identifiants d'authentification.
• Secret client : secret Secret Manager contenant le secret client associé au connecteur.

Limites du système

Le connecteur WooCommerce peut traiter deux transactions par seconde et par nœud, et limite les transactions au-delà de cette limite. Par défaut, Integration Connectors alloue deux nœuds (pour une meilleure disponibilité) à une connexion.

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

Remarque : Le nombre de nœuds de connecteurs d'intégration s'ajustera automatiquement de manière dynamique en fonction de votre utilisation. Toutefois, si vous souhaitez réserver de la capacité pour des volumes importants sans en attente de l'autoscaling, vous pouvez ajuster la valeur minimale du nombre de nœuds pour une connexion. Plus sont nécessaires pour traiter davantage de transactions pour une connexion. À l'inverse, le nombre de nœuds sont requis si une connexion traite moins de transactions. Pour configurer le nœud, procédez comme suit : , procédez comme suit:

• Si vous avez opté pour le paiement à l'usage, configurez les valeurs minimale et maximale du nœud sur la page "Modifier la connexion".
• Si vous disposez d'un abonnement client, contactez l'assistance.

Le nombre maximal de transactions qu'un nœud peut gérer dépend de divers facteurs. Par conséquent, avant d'ajuster le nombre minimal de nœuds pour améliorer le débit, nous vous recommandons de vérifier si vos systèmes backend sont configurés de manière optimale pour gérer le trafic requis.

Utiliser la connexion WooCommerce 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 dans une intégration via la tâche "Connecteurs".

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

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.

Remarque : Vous pouvez afficher les entités, les opérations et les actions d'un connecteur dans la tâche Connecteurs.

• 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é, 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.

Remarque : Toutes les entités et les actions seront associées à un schéma. Par exemple, un schéma d'action comportera les détails des paramètres tels que : le paramètre noms et le type de données correspondant. Le schéma (métadonnées) des entités et des actions est récupéré par la connexion à partir de votre backend. Si des mises à jour sont apportées au schéma, elles ne seront pas automatiquement répercutées dans vos connexions existantes. Vous devez actualiser manuellement le schéma. Pour actualiser le schéma d'une connexion, ouvrez la page Détails de la connexion de la connexion, puis cliquez sur Actualiser le schéma de connexion.

Actions

Cette section liste les actions compatibles avec le connecteur. Pour savoir comment configurer les actions, consultez Exemples d'actions.

Remarque:Les résultats de toutes les actions sont disponibles Réponse JSON dans le connectorOutputPayload de la tâche Connectors de réponse après l'exécution de votre intégration.

Mettre à jour l'action "Zones de livraison"

Cette action vous permet de modifier les zones géographiques d'une zone de livraison dans WooCommerce.

Paramètres d'entrée de l'action "Mettre à jour les zones de livraison"

Nom du paramètre	Type de données	Requis	Description
ZoneId	Chaîne	Oui	ID de la zone à mettre à jour.
Emplacements	Chaîne	Oui	Informations sur l'établissement.

Pour savoir comment configurer l'action Update Shipping Zone Locations, consultez la section Exemples d'actions.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : mettre à jour les adresses des zones de livraison

Dans cet exemple, modifiez les zones géographiques d'une zone de livraison.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action Update Shipping Zone Locations, puis cliquez sur OK.
3. 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 à la suivante dans le champ Default Value :

   {
       "ZoneId": "7",
       "Locations": "[{\"code\":\"BR:SP\",\"type\":\"state\"}]"
     }

Si l'action aboutit, la Réponse connectorOutputPayload de la tâche Update Shipping Zone Locations aura une valeur semblable à celle-ci:

[ { "code": "BR:SP", "type": "state",
    "_links_collection_href": "https://your-website.com/wp-json/wc/v3/shipping/zones/7/locations", 
    "_links_describes_href": "https://your-website.com/wp-json/wc/v3/shipping/zones/7", 
    "success": "true" } ]

Exemples d'opérations d'entité

Exemple : Lister les enregistrements d'une entité

Cet exemple répertorie les enregistrements d'une entité Orders.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Orders dans la liste Entity.
3. Sélectionnez l'opération List, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), vous pouvez définir le paramètre filterClause selon vos besoins.

   Par exemple, si vous définissez la clause de filtre sur Id='891', seuls les enregistrements dont l'ID de commande est 891 sont listés.

Exemple : Obtenir un enregistrement unique à partir d'une entité

Cet exemple extrait un enregistrement de l'entité Orders.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Orders dans la liste Entity.
3. Sélectionnez l'opération Get, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId, puis saisissez 891 dans le champ Default Value (Valeur par défaut).

   Ici, 891 est un identifiant unique pour l'entité de ressource Orders.

Exemple : Supprimer un enregistrement d'une entité

Cet exemple supprime un enregistrement de l'entité Orders.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Orders dans la liste Entity.
3. Sélectionnez l'opération Delete, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId, puis saisissez 891 dans le champ Default Value (Valeur par défaut).

   Si l'entité utilise des clés primaires composites au lieu de spécifier entityId, vous pouvez également Définissez la clause filterClause. Par exemple, Id='891'.

Exemple : Créer un enregistrement dans une entité

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

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Orders dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. 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:

   {
   "BillingFirstName": "Alex",
   "BillingLastName": "Smith",
   "Status":"processing",
   "CustomerId": 1,
   "ShippingAddress1":"809/2 Downtown, Alaska, United States"
   }

Si l'intégration aboutit, le champ connectorOutputPayload de la tâche du connecteur contient la réponse de l'opération de création.

{ 
"Id": 1010 
}

Exemple – Mettre à jour un enregistrement dans une entité

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

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Orders dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. 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:

   {
   "Status": "on-hold"
   }

5. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId et puis saisissez 1010 dans le champ Default Value (Valeur par défaut).

Si l'intégration aboutit, le champ connectorOutputPayload de la tâche du connecteur contient la réponse de l'opération de mise à jour.

{
"Id": 1010
}