WooCommerce

Usa el conector de WooCommerce para realizar operaciones de inserción, eliminación, actualización y lectura en WooCommerce.

Antes de comenzar

Antes de usar el conector de WooCommerce, realiza las siguientes tareas:

• En tu proyecto de Google Cloud, haz lo siguiente:
  • Asegúrate de que la conectividad de red esté configurada. Para obtener información sobre los patrones de red, consulta Conectividad de red.
  • Otorga el rol de IAM roles/connectors.admin al usuario que configure el conector.
  • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

  • Habilita los siguientes servicios:
    • secretmanager.googleapis.com (API de Secret Manager)
    • connectors.googleapis.com (API de conectores)

    Para comprender cómo habilitar servicios, consulta Habilita servicios.

  Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

   Ir a la página Conexiones

2. Haz clic en + CREAR NUEVO para abrir la página Crear conexión.
3. En la sección Ubicación, elige la ubicación para la conexión.
   1. Región: selecciona una ubicación de la lista desplegable.

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

   2. Haz clic en SIGUIENTE.
4. En la sección Detalles de la conexión, completa lo siguiente:
   1. Conector: Selecciona WooCommerce en la lista desplegable de conectores disponibles.
   2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
   3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de las conexiones no pueden superar los 49 caracteres.
   4. De manera opcional, ingresa una Descripción para la instancia de conexión.
   5. De manera opcional, habilita Cloud Logging y, luego, selecciona un nivel de registro. De forma predeterminada, el nivel de registro se establece en Error.
   6. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
   7. De manera opcional, configura los parámetros de nodo de conexión:
      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

   Nota: Puedes personalizar los valores de los nodos de conexión solo si eres un cliente de pago por uso.
   8. Usar proxy: selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión y configurar los siguientes valores:
   • Esquema de autenticación del proxy: Selecciona el tipo de autenticación para autenticar con el servidor proxy. Se admiten los siguientes tipos de autenticación:
     • Básico: Autenticación HTTP básica.
     • Resumen: Autenticación de HTTP de resumen.
   • Usuario de proxy: Un nombre de usuario que se usará para autenticarse con el servidor proxy.
   • Contraseña de proxy: el secreto de Secret Manager de la contraseña del usuario.
   • Tipo de SSL del proxy: el tipo de SSL que se usará para conectarse al servidor del proxy. Se admiten los siguientes tipos de autenticación:
     • Automático: Configuración predeterminada. Si la URL es HTTPS, se usa la opción Túnel. Si la URL es una URL HTTP, se usa la opción NUNCA.
     • Siempre: La conexión siempre está habilitada para SSL.
     • Nunca: La conexión no está habilitada para SSL.
     • Túnel: La conexión se realiza a través de un proxy de túnel. El servidor proxy abre una conexión con el host remoto y el tráfico fluye de un lado a otro a través del proxy.
   • En la sección Proxy Server, ingresa los detalles del servidor proxy.
     1. Haz clic en Agregar destino.
     2. Selecciona un Tipo de destino.
        • Dirección del host: Especifica el nombre de host o la dirección IP del destino.

          Si deseas establecer una conexión privada a tu sistema de backend, haz lo siguiente:

          • Crea un adjunto de servicio de PSC.
          • Crea un adjunto de extremo y, luego, ingresa los detalles del adjunto del extremo en el campo Dirección del host.
   9. De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
   10. Haga clic en SIGUIENTE.
5. En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte.
   1. Tipo de destino: Selecciona un Tipo de destino.
      • Selecciona Dirección de host en la lista para especificar el nombre de host o la dirección IP del destino.
      • Si deseas establecer una conexión privada a tus sistemas de backend, selecciona Adjunto de extremo en la lista y, luego, selecciona el archivo adjunto de extremo requerido en la lista Adjunto de extremo.
        Nota: Para comprender cómo crear un adjunto de extremo, consulta Adjunto de servicio de PSC y Adjunto de extremo. Después de crear el archivo adjunto del extremo, este aparecerá en la lista Adjunto de extremo.

      Si deseas establecer una conexión pública a tus sistemas de backend con seguridad adicional, puedes configurar direcciones IP salientes estáticas para tus conexiones y, luego, configurar tus reglas de firewall para incluir en la lista de entidades permitidas solo las direcciones IP estáticas específicas.

   2. Haz clic en SIGUIENTE.
6. En la sección Autenticación, ingresa los detalles de autenticación.

   Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

7. Después de especificar los detalles de autenticación, haz clic en SIGUIENTE.
8. Revisa: Revisa tus detalles de conexión y autenticación.
9. Haz clic en Crear.

Configura la autenticación

Ingresa los detalles de autenticación.

• Clave del consumidor: Es la clave del consumidor que asigna WooCommerce cuando se crean las credenciales de autenticación.
• Secreto del consumidor: El Secret de Secret Manager que contiene el secreto del consumidor asociado con el conector.

Limitaciones del sistema

El conector de WooCommerce puede procesar 2 transacciones por segundo por nodo y limita las transacciones que superen este límite. De forma predeterminada, Integration Connectors asignan 2 nodos (para una mejor disponibilidad) a una conexión.

Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.

Nota: La cantidad de nodos de Integration Connectors se ajustará automáticamente de forma dinámica según tu uso. Sin embargo, si deseas reservar capacidad para volúmenes grandes sin esperar al ajuste de escala automático, puedes ajustar el valor mínimo de nodos para una conexión. Se requieren más nodos para procesar más transacciones para una conexión. Por el contrario, se requieren menos nodos si una conexión procesa menos transacciones. Para configurar los valores del nodo, haz lo siguiente:

• Si eres cliente de pago por uso, configura el valor mínimo y máximo de los nodos en la página de edición de la conexión.
• Si eres cliente con suscripción, comunícate con el equipo de asistencia.

Las transacciones máximas que puede controlar un nodo dependen de varios factores. Por lo tanto, antes de ajustar los nodos mínimos para obtener una mejor capacidad de procesamiento, te recomendamos que verifiques si tus sistemas de backend están configurados de manera óptima para controlar el tráfico requerido.

Usa la conexión de WooCommerce en una integración

Después de crear la conexión, estará disponible en la integración de Apigee y en la Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

• Para comprender cómo crear y usar la tarea Connectors en la integración de Apigee, consulta Tarea Connectors.
• Para comprender cómo crear y usar la tarea Connectors en Application Integration, consulta Tarea Connectors.

Entidades, operaciones y acciones

Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.

Nota: Puedes ver las entidades, operaciones y acciones de un conector en la tarea de conectores.

• Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

  Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.

• Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Lista
  • Obtén
  • Crear
  • Actualizar
  • Borrar

  Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, estas operaciones no compatibles no se incluyen en la lista Operations.

• Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Por lo general, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Nota: Todas las entidades y acciones tendrán un esquema asociado. Por ejemplo, un esquema de acción tendrá los detalles de los parámetros, como los nombres de los parámetros y su tipo de datos correspondiente. La conexión recupera el esquema (metadatos) de las entidades y las acciones durante el tiempo de ejecución desde tu backend. Si hay actualizaciones en el esquema, estas no se reflejarán automáticamente en tus conexiones existentes. Debes actualizar el esquema de forma manual. Para actualizar el esquema de una conexión, abre la página Detalles de la conexión de la conexión y, luego, haz clic en Actualizar esquema de conexión.

Acciones

En esta sección, se enumeran las acciones que admite el conector. Para comprender cómo configurar las acciones, consulta Ejemplos de acciones.

Nota: Los resultados de todas las acciones estarán disponibles como una respuesta JSON en el parámetro de respuesta connectorOutputPayload de la tarea Connectors después de ejecutar la integración.

Acción Actualizar ubicaciones de zonas de envío

Esta acción te permite actualizar las ubicaciones de una zona de envío en WooCommerce.

Parámetros de entrada de la acción Update Shipping Zone Locations

Nombre del parámetro	Tipo de datos	Obligatorio	Descripción
ZoneId	String	Sí	Es el ID de la zona que se actualizará.
Ubicaciones	String	Sí	Los detalles de la ubicación

Para ver ejemplos sobre cómo configurar la acción Update Shipping Zone Locations, consulta Ejemplos de acciones.

Ejemplos de acciones

En esta sección, se describe cómo realizar algunas de las acciones de este conector.

Ejemplo: Cómo actualizar las ubicaciones de las zonas de envío

En este ejemplo, se actualizan las ubicaciones de una zona de envío.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción Update Shipping Zone Locations y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

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

Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea Update Shipping Zone Locations tendrá un valor similar al siguiente:

[ { "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" } ]

Ejemplos de operaciones de entidades

Ejemplo: Lista de registros de una entidad

En este ejemplo, se enumeran los registros de una entidad Orders.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Orders en la lista Entity.
3. Selecciona la operación List y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, puedes configurar filterClause según tus necesidades.

   Por ejemplo, si estableces la cláusula de filtro en Id='891', se enumerarán solo aquellos registros cuyo ID de pedido sea 891.

Ejemplo: Cómo obtener un solo registro de una entidad

En este ejemplo, se recupera un registro de la entidad Orders.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Orders en la lista Entity.
3. Selecciona la operación Get y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en entityId y, luego, ingresa 891 en el campo Default Value.

   Aquí, 891 es un identificador único para la entidad Orders del recurso.

Ejemplo: Borra un registro de una entidad

En este ejemplo, se borra un registro de la entidad Orders.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Orders en la lista Entity.
3. Selecciona la operación Delete y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en entityId y, luego, ingresa 891 en el campo Default Value.

   Como alternativa, si la entidad tiene claves primarias compuestas en lugar de especificar entityId, puedes establecer filterClause. Por ejemplo, Id='891'.

Ejemplo: Crea un registro en una entidad

En este ejemplo, se crea un registro en la entidad Orders.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Orders en la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

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

Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá la respuesta de la operación de creación.

{ 
"Id": 1010 
}

Ejemplo: Actualiza un registro en una entidad

En este ejemplo, se actualiza un registro en la entidad Orders.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Orders en la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

   {
   "Status": "on-hold"
   }

5. En la sección Task Input de la tarea Connectors, haz clic en entityId y, luego, ingresa 1010 en el campo Default Value.

Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá la respuesta de la operación de actualización.

{
"Id": 1010
}