Shopify

El conector de Shopify te permite realizar operaciones de inserción, eliminación, actualización y lectura en Shopify.

Versiones compatibles

Este conector modela las APIs de Shopify Admin como una base de datos relacional.

Antes de comenzar

Antes de usar el conector de Shopify, realice las siguientes tareas:

  • En tu proyecto de Google Cloud, haz lo siguiente:
    • Otorga el rol de IAM roles/connectors.admin al usuario. configurar 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 Shopify 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 conexión 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.

    8. ID de la app: AppId para la API de Admin.
    9. Cantidad máxima de puntos por llamada: Especifica la cantidad de puntos que costará una llamada.
    10. Esquema: Especifica la versión del servidor de Shopify con la que te conectarás.
    11. 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:

    12. De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
    13. 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.

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

      Para ingresar destinos adicionales, haz clic en +AGREGAR DESTINO.

    2. Haga clic en SIGUIENTE.
  6. En la sección Autenticación, ingresa los detalles de autenticación.
    1. La conexión de Shopify no requiere autenticación.
    2. Haga clic en SIGUIENTE.
  7. Revisa: Revisa tus detalles de conexión y autenticación.
  8. Haz clic en Crear.

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.

  • 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:

    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.

Ejemplos de operaciones de entidades

Ejemplo: Cómo mostrar una lista de todos los productos

En este ejemplo, se enumeran todos los registros de la entidad Products.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Products en la lista Entity.
  3. Selecciona la operación List y, luego, haz clic en Listo.

Ejemplo: obtén detalles del cliente

En este ejemplo, se obtienen los detalles del cliente especificado de la Customers.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Customers en la lista Entity.
  3. Selecciona la operación Get y haz clic en Listo.
  4. Ingresa el ID de entidad del cliente cuyos detalles deseas recuperar.

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

Ejemplo: Cómo borrar un registro de pedido

En este ejemplo, se borra el orden especificado del Order.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Order en la lista Entity.
  3. Selecciona la operación Delete y haz clic en Listo.
  4. Ingresa el ID de entidad del pedido que quieres borrar.

    En la sección Entrada de tarea de la tarea Conectores, Haz clic en entityId y, luego, ingresa 475009571483E15 el campo Valor predeterminado.

Ejemplo: Cómo agregar un cliente

En este ejemplo, se agrega el cliente especificado a la entidad Customer.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Customer de 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:
    {
    "FirstName": "Test",
    "LastName": "Customer5"
    }

    Cuando se ejecuta este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de tu tarea de conector:

    {
    "Id": 6448083206296
    }

Ejemplo: Crea un registro en DiscountCode

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

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona DiscountCode de la lista Entity.
  3. Selecciona la operación Create y haz clic en Listo.
  4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa valor similar al siguiente en el campo Default Value:
    {
    "PriceRuleId": 1.394097291568E12,
    "Code": "FREESHIP2025798"
    }

    Cuando se ejecuta este ejemplo, se muestra una respuesta similar a la siguiente: siguiente en la variable de salida connectorOutputPayload de tu tarea de conector:

    {
    "Id": 1.97836790828E13,
    "PriceRuleId": null
    }

Ejemplo: Crea un registro en Pricerule

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

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Pricerule de 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:
    {
    "Id": 7.13459564696E11,
    "AllocationMethod": "each",
    "CustomerSelection": "all",
    "TargetType": "line_item",
    "UsageLimit": 100.0,
    "Title": "DP_PriceRule"
    }

    Si ejecutas este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

    {
    "Id": 197836790834,
    "PriceRuleId": null
    }

Ejemplo: Crea un registro en ProductVariant

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

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona ProductVariant de 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:
    {
    "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
    }

    Cuando se ejecuta este ejemplo, se muestra una respuesta similar a la siguiente en tu conector. variable de salida connectorOutputPayload de la tarea:

    {
    "Id": 42711984373912
    }

Ejemplo: Actualiza los detalles del cliente

En este ejemplo, se actualizan los detalles del cliente especificado en la entidad Customer.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Customer 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:
    {
    "FirstName": "Test",
    "LastName": "Customer2"
    }
  5. Ingresa el ID de la entidad del cliente que deseas borrar.

    En la sección Entrada de tarea de la tarea Conectores, Haz clic en entityId y, luego, ingresa 648400653532 el campo Valor predeterminado.

    Como alternativa, en lugar de especificar entityId, también puedes establecer filterClause en 648400653532.

    Si ejecutas este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

    {
    "Id": 648400653532
    }

Ejemplo: Actualiza un registro en ProductVariant

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

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona ProductVariant de 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:
    {
    "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. Especifica el ID de la entidad del registro que deseas actualizar.

    Para establecer el ID de la entidad, Haz clic en entityId y, luego, ingresa 34601602744472 en el Valor predeterminado .

    Si ejecutas este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

    {
    "Id": 2484258073471
    }

Usar Terraform para crear conexiones

Puedes usar Terraform resource para crear una conexión nueva.

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.

Si quieres ver una plantilla de Terraform de muestra para crear conexiones, consulta la plantilla de muestra.

Cuando crees esta conexión con Terraform, debes establecer las siguientes variables en tu archivo de configuración de Terraform:

Nombre del parámetro Tipo de datos Obligatorio Descripción
max_points_per_call STRING Falso Especifica cuántos puntos costará una llamada.
schema_v23 ENUM Falso Especifica la versión del servidor de Shopify con la que te conectarás. Los valores admitidos son: REST-2023-04, REST-2023-07, GRAPHQL-2023-04 y GRAPHQL-2023-07.
proxy_enabled BOOLEAN Falso Selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión.
proxy_auth_scheme ENUM Falso Es el tipo de autenticación que se usará para autenticarse en el proxy de ProxyServer. Los valores admitidos son: BASIC, DIGEST, NONE.
proxy_user STRING Falso Es un nombre de usuario que se usará para autenticarse en el proxy de ProxyServer.
proxy_password SECRET Falso Una contraseña que se usará para autenticarse en el proxy ProxyServer.
proxy_ssltype ENUM Falso Es el tipo de SSL que se usará para conectarse al proxy de ProxyServer. Los valores admitidos son AUTO, ALWAYS, NEVER, TUNNEL.

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

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

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

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?