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 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 que configura 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:

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
Haz clic en + CREAR NUEVO para abrir la página Crear conexión.
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. Haga clic en SIGUIENTE.
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 las conexiones no pueden superar los 63 caracteres.
4. De manera opcional, ingresa una Descripción para la instancia de conexión.
5. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
6. 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.
7. ID de la app: AppId para la API de Admin.
8. Cantidad máxima de puntos por llamada: Especifica la cantidad de puntos que costará una llamada.
9. Esquema: Especifica la versión del servidor de Shopify con la que te conectarás.
10. Usar proxy: selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión y configurar los siguientes valores:
11. De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
12. Haga clic en SIGUIENTE.
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.
  1. En el campo Dirección de host, especifica el nombre de host o la dirección IP del destino.
    1. Si deseas establecer una conexión privada a tus sistemas de backend, sigue estos pasos:
      1. Crea un adjunto de servicio de PSC.
      2. Crea un adjunto de extremo y, luego, ingresa los detalles del adjunto del extremo en el campo Dirección del host.
    2. Si deseas establecer una conexión pública a tus sistemas de backend con seguridad adicional, puedes considerar configurar direcciones IP salientes estáticas para tus conexiones y, luego, configurar tus reglas de firewall para incluir solo las direcciones IP estáticas específicas.
  Para ingresar destinos adicionales, haz clic en +AGREGAR DESTINO.
2. Haga clic en SIGUIENTE.
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.
Revisa: Revisa tus detalles de conexión y autenticación.
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:
- 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, tales operaciones no compatibles no aparecerán 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. 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: enumera todos los productos

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

En el cuadro de diálogo Configure connector task, haz clic en Entities.
Selecciona Products de la lista Entity.
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 entidad Customers.

En el cuadro de diálogo Configure connector task, haz clic en Entities.
Selecciona Customers de la lista Entity.
Selecciona la operación Get y, luego, haz clic en Listo.
Ingresa el ID de la entidad del cliente cuyos detalles deseas recuperar.
En la sección Entrada de la tarea de la tarea Conectores, haz clic en entityId y, luego, ingresa 365009521884E12 en el campo Valor predeterminado.

Ejemplo: Cómo borrar un registro de pedido

En este ejemplo, se borra el orden especificado de la entidad Order.

En el cuadro de diálogo Configure connector task, haz clic en Entities.
Selecciona Order de la lista Entity.
Selecciona la operación Delete y, luego, haz clic en Listo.
Ingresa el ID de la entidad del pedido que deseas borrar.
En la sección Entrada de la tarea de la tarea Conectores, haz clic en entityId y, luego, ingresa 475009571483E15 en el campo Valor predeterminado.

Ejemplo: agregar un cliente

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

En el cuadro de diálogo Configure connector task, haz clic en Entities.
Selecciona Customer de la lista Entity.
Selecciona la operación Create y haz clic en Listo.
En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:
```
{
"FirstName": "Test",
"LastName": "Customer5"
}
```
Cuando ejecutas este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:
```
{
"Id": 6448083206296
}
```

Ejemplo: Crea un registro en DiscountCode

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

En el cuadro de diálogo Configure connector task, haz clic en Entities.
Selecciona DiscountCode de la lista Entity.
Selecciona la operación Create y haz clic en Listo.
En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:
```
{
"PriceRuleId": 1.394097291568E12,
"Code": "FREESHIP2025798"
}
```
Si ejecutas este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:
```
{
"Id": 1.97836790828E13,
"PriceRuleId": null
}
```

Ejemplo: Crea un registro en Pricerule

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

En el cuadro de diálogo Configure connector task, haz clic en Entities.
Selecciona Pricerule de la lista Entity.
Selecciona la operación Create y haz clic en Listo.
En la sección Entrada de la tarea de la tarea Conectores, 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"
}
```
Cuando 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.

En el cuadro de diálogo Configure connector task, haz clic en Entities.
Selecciona ProductVariant de la lista Entity.
Selecciona la operación Create y haz clic en Listo.

En la sección Entrada de la tarea de la tarea Conectores, 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
}

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

{
"Id": 42711984373912
}

Ejemplo: Actualiza los detalles del cliente

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

En el cuadro de diálogo Configure connector task, haz clic en Entities.
Selecciona Customer de la lista Entity.
Selecciona la operación Update y haz clic en Listo.
En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:
```
{
"FirstName": "Test",
"LastName": "Customer2"
}
```
Ingresa el ID de la entidad del cliente que deseas borrar.
En la sección Entrada de la tarea de la tarea Conectores, haz clic en entityId y, luego, ingresa 648400653532 en el campo Valor predeterminado.

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

Si ejecutas este ejemplo, se mostrará 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.

En el cuadro de diálogo Configure connector task, haz clic en Entities.
Selecciona ProductVariant de la lista Entity.
Selecciona la operación Update y haz clic en Listo.

En la sección Entrada de la tarea de la tarea Conectores, 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
}

Especifica el ID de entidad del registro que se actualizará.
Para establecer el ID de la entidad, haz clic en entityId y, luego, ingresa 34601602744472 en el campo Valor predeterminado.

Si ejecutas este ejemplo, se mostrará una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:
```
{
"Id": 2484258073471
}
```

Usa Terraform para crear conexiones

Puedes usar el recurso de Terraform 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 muestra de Terraform para crear conexiones, consulta la plantilla de muestra.

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

Nombre del parámetro	Tipo de datos	Requeridos	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. Valores admitidos: REST-2023-04, REST-2023-07, GRAPHQL-2023-04, GRAPHQL-2023-07
proxy_enabled	BOOLEAN	Falso	Selecciona esta casilla de verificación para configurar un servidor proxy para la conexión.
proxy_auth_scheme	ENUM	Falso	El tipo de autenticación que se usará para autenticar en el proxy de ProxyServer. Los valores admitidos son BASIC, DIGEST y NONE.
proxy_user	STRING	Falso	Un nombre de usuario que se usará para autenticarse en el proxy de ProxyServer.
proxy_password	SECRET	Falso	Una contraseña que se utilizará para autenticarse en el proxy de ProxyServer.
proxy_ssltype	ENUM	Falso	El tipo de SSL que se usará cuando se establezca la conexión con el proxy de ProxyServer. Los valores admitidos son AUTO, ALWAYS, NEVER, TUNNEL.

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

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

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

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?

Comprende cómo suspender y reanudar una conexión.
Descubre cómo supervisar el uso de los conectores.
Descubre cómo ver los registros del conector.