Conexión de Shopify en Jitterbit Studio

Introducción

Una conexión de Shopify, creada mediante el conector de Shopify, establece acceso a Shopify. Una vez que se configura una conexión, se pueden crear instancias de actividades de Shopify asociadas a esa conexión para usarlas como orígenes (para proporcionar datos en una operación) o como destinos (para consumir datos en una operación).

Crear o editar una conexión de Shopify

Se crea una nueva conexión de Shopify usando el conector de Shopify desde una de estas ubicaciones:

• La pestaña Project endpoints and connectors de la paleta de componentes de diseño (consulta Design component palette).
• La página Global Endpoints (consulta Create a global endpoint en Global Endpoints).

Se puede editar una conexión de Shopify existente desde estas ubicaciones:

• La pestaña Project endpoints and connectors de la paleta de componentes de diseño (consulta Design component palette).
• La pestaña Components del panel del proyecto (consulta Component actions menu en Project pane Components tab).
• La página Global Endpoints (consulta Edit a global endpoint en Global Endpoints).

Configurar una conexión de Shopify

A continuación se describe cada elemento de la interfaz de usuario de la pantalla de configuración de la conexión de Shopify.

La interfaz utilizada en la configuración de la conexión de Shopify depende de la opción Authentication mechanism seleccionada:

• Credential-based Auth: Con esta opción, la conexión se autentica usando credenciales de API para tu tienda de Shopify.

• OAuth: Con esta opción, la conexión se autentica a través de Shopify en una pestaña del navegador separada (3-legged OAuth). Esta opción requiere el uso de la versión del agente 10.83 / 11.21 o posterior.

Credential-based Auth

Cuando se selecciona Credential-based Auth como Authentication mechanism, se presenta la interfaz descrita a continuación.

• Connection name: Ingresa un nombre para identificar la conexión. El nombre debe ser único para cada conexión de Shopify y no debe contener barras diagonales / ni dos puntos :. Este nombre también se usa para identificar el endpoint de Shopify, que se refiere tanto a una conexión específica como a sus actividades.

• Store name: Ingresa el nombre de tu tienda de Shopify.

• Authentication mechanism: Selecciona Credential-based Auth para autenticarte usando credenciales de API.

• Authentication type: Selecciona el tipo de autenticación, ya sea Basic authentication o Shopify access token. Si usas una aplicación privada, selecciona Basic authentication. Si usas una aplicación personalizada creada en el administrador de Shopify, selecciona Shopify access token.

• Clave API: Si se seleccionó Autenticación básica como Tipo de autenticación, ingresa la clave API para la instancia de Shopify.

• Contraseña: Si se seleccionó Autenticación básica como Tipo de autenticación, ingresa la contraseña para la instancia de Shopify.

• Token de acceso API: Si se seleccionó Token de acceso de Shopify como Tipo de autenticación, ingresa el token de acceso API para la instancia de Shopify.

• Configuración opcional: Haz clic para expandir la configuración adicional:

  • Usar configuración de proxy (solo agente privado): Al usar un agente privado, se puede seleccionar esta configuración para usar la configuración de proxy del agente privado.

  • Versión de API: Selecciona la versión de Shopify REST Admin API, una de 2022-04 (predeterminada), 2023-01, 2023-04, 2023-07, 2023-10, 2024-01, 2024-04, 2024-07, 2024-10, 2025-01, 2025-04, 2025-07, 2025-10, 2026-04, o 2026-07. Según los puntos finales de API que Shopify admita en la versión de API que se utilice, los objetos y subobjetos disponibles para seleccionar durante la configuración de la actividad pueden variar. Si cambias la Versión de API para una conexión que tiene actividades configuradas existentes, consulta consideraciones adicionales en Cambiar la versión de API a continuación.

    Importante

    Shopify lanza una nueva versión de API cada tres meses y mantiene cada versión de lanzamiento durante un mínimo de doce meses. Una vez que se depreca una versión de API, Shopify ya no mantendrá esa versión y cualquier llamada de API que solicite esa versión se enrutará automáticamente a la versión estable más antigua actualmente compatible.

    Shopify puede deprecar ciertos puntos finales con la introducción de una nueva versión de API. Como resultado, es posible que necesites cambiar tus aplicaciones y configuraciones de actividad debido a funciones cambiadas o retiradas.

    Las versiones y puntos finales de API deprecados se anuncian en el registro de cambios de Shopify, donde se encuentran disponibles más detalles e información de migración relevante.

  • Encabezados de solicitud: Usa esta tabla para agregar pares clave-valor que se envíen con cada solicitud de actividad. Cada valor agregado a la tabla se incluye en el esquema de solicitud de cada actividad.

    • Agregar: Agrega una fila a la tabla. Ingresa un par clave-valor para cada propiedad.
    • Enviar: Guarda el par clave-valor en la tabla. Visible al pasar el cursor sobre una fila en modo de edición.
    • Descartar: Descarta una fila nueva o cualquier edición realizada en una fila existente. Visible al pasar el cursor sobre una fila en modo de edición.
    • Editar: Te permite editar un par clave-valor existente. Visible al pasar el cursor sobre una fila existente.
    • Eliminar: Elimina la fila de la tabla. Visible al pasar el cursor sobre una fila existente.
    • Borrar todo: Elimina todas las filas de la tabla.

    Importante

    Los campos en la tabla Encabezados de solicitud muestran el icono de variable solo en modo de edición. Para que los valores de variables de estos campos se completen en tiempo de ejecución, la versión del agente debe ser al menos 10.75 / 11.13.

    Los campos en la tabla Encabezados de solicitud no admiten el uso de variables para pasar JSON sin procesar. Si tu caso de uso no admite definir JSON sin procesar directamente en los campos, escapa el contenido JSON antes de pasarlo con una variable. Por ejemplo, escapar {"success": "true"}; se convierte en {\"success\": \"true\"};.

• Prueba: Haz clic para verificar la conexión usando la configuración proporcionada. Cuando se prueba la conexión, el agente o los agentes en el grupo de agentes asociado con el entorno actual descargan la versión más reciente del conector. Este conector admite suspender la descarga de la versión más reciente del conector mediante la política de organización Deshabilitar actualización automática del conector.

• Guardar: Haz clic para guardar y cerrar la configuración de conexión.

• Descartar cambios: Después de realizar cambios en una configuración nueva o existente, haz clic para cerrar la configuración sin guardar. Un mensaje te pide que confirmes que deseas descartar los cambios.

• Eliminar: Después de abrir una configuración de conexión existente, haz clic para eliminar permanentemente la conexión del proyecto y cerrar la configuración (consulta Dependencias de componentes, eliminación y extracción). Un mensaje te pide que confirmes que deseas eliminar la conexión.

OAuth

Cuando se selecciona OAuth como el Mecanismo de autenticación, se presenta la interfaz descrita a continuación. Para notas importantes sobre el comportamiento del token de acceso y el token de actualización, consulta Notas importantes.

• Nombre de conexión: Ingresa un nombre para identificar la conexión. El nombre debe ser único para cada conexión de Shopify y no debe contener barras diagonales / ni dos puntos :. Este nombre también se utiliza para identificar el endpoint de Shopify, que se refiere tanto a una conexión específica como a sus actividades.

• Nombre de tienda: Ingresa el nombre de la tienda Shopify. Este es el valor {shop} utilizado en las URLs de OAuth configuradas en Requisitos previos.

• Mecanismo de autenticación: Selecciona OAuth para autenticarte a través de Shopify en una pestaña del navegador separada (OAuth de 3 etapas). Esta opción requiere el uso de la versión del agente 10.83 / 11.21 o posterior.

• Aplicación OAuth: Utiliza el menú para seleccionar una aplicación OAuth 2.0 en Aplicaciones privadas. Esta categoría muestra las aplicaciones del conector Shopify configuradas en la página Registros de aplicaciones de la Consola de administración. Para obtener más información sobre cómo configurar una aplicación del conector Shopify en la página Registros de aplicaciones, consulta Requisitos previos.

• Iniciar sesión con Shopify: Haz clic para autenticarte a través de Shopify en una pestaña del navegador separada y proporciona consentimiento para que Jitterbit acceda a la tienda Shopify.

• Configuración opcional: Haz clic para expandir configuraciones adicionales:

  • Usar configuración de proxy (solo agente privado): Cuando se utiliza un agente privado, se puede seleccionar esta configuración para usar configuración de proxy del agente privado.

  • Versión de API: Selecciona la versión de Shopify REST Admin API, una de 2022-04 (predeterminada), 2023-01, 2023-04, 2023-07, 2023-10, 2024-01, 2024-04, 2024-07, 2024-10, 2025-01, 2025-04, 2025-07, 2025-10, 2026-04 o 2026-07. Dependiendo de los endpoints de API que Shopify admita en la versión de API que se utilice, los objetos y subobjetos disponibles para seleccionar durante la configuración de actividades pueden variar. Si cambias la Versión de API para una conexión que tiene actividades configuradas existentes, consulta consideraciones adicionales en Cambiar la versión de API a continuación.

    Importante

    Shopify lanza una nueva versión de API cada tres meses y mantiene cada versión de lanzamiento durante un mínimo de doce meses. Una vez que Shopify depreca una versión de API, ya no mantendrá esa versión y cualquier llamada de API que solicite esa versión se enrutará automáticamente a la versión estable más antigua actualmente compatible.

Shopify puede deprecar ciertos endpoints con la introducción de una nueva versión de API. Como resultado, es posible que necesites cambiar tus aplicaciones y configuraciones de actividades debido a funciones modificadas o retiradas.

Las versiones de API y endpoints deprecados se anuncian en el registro de cambios de Shopify, donde encontrarás más detalles e información relevante sobre migración.

• Request Headers: Utiliza esta tabla para agregar pares clave-valor que se envíen con cada solicitud de actividad. Cada valor agregado a la tabla se incluye en el esquema de solicitud de cada actividad.

  • Add: Agrega una fila a la tabla. Ingresa un par clave-valor para cada propiedad.
  • Submit: Guarda el par clave-valor en la tabla. Visible al pasar el cursor sobre una fila en modo edición.
  • Discard: Descarta una fila nueva o cualquier cambio realizado en una fila existente. Visible al pasar el cursor sobre una fila en modo edición.
  • Edit: Permite editar un par clave-valor existente. Visible al pasar el cursor sobre una fila existente.
  • Delete: Elimina la fila de la tabla. Visible al pasar el cursor sobre una fila existente.
  • Clear All: Elimina todas las filas de la tabla.

  Importante

  Los campos en la tabla Request Headers muestran el icono de variable solo en modo edición. Para que los valores de variables de estos campos se completen en tiempo de ejecución, la versión del agente debe ser al menos 10.75 / 11.13.

  Los campos en la tabla Request Headers no permiten usar variables para pasar JSON sin procesar. Si tu caso de uso no permite definir JSON sin procesar directamente en los campos, escapa el contenido JSON antes de pasarlo con una variable. Por ejemplo, escapar {"success": "true"}; se convierte en {\"success\": \"true\"};.

• Test: Haz clic para verificar la conexión usando la configuración proporcionada. Cuando se prueba la conexión, el agente o los agentes en el grupo de agentes asociado al entorno actual descargan la versión más reciente del conector. Este conector permite suspender la descarga de la versión más reciente del conector mediante la política organizacional Disable Auto Connector Update.

• Save: Haz clic para guardar y cerrar la configuración de conexión.

• Discard changes: Después de realizar cambios en una configuración nueva o existente, haz clic para cerrar la configuración sin guardar. Un mensaje te pide que confirmes que deseas descartar los cambios.

• Delete: Después de abrir una configuración de conexión existente, haz clic para eliminar permanentemente la conexión del proyecto y cerrar la configuración (consulta Component dependencies, deletion, and removal). Un mensaje te pide que confirmes que deseas eliminar la conexión.

Cambiar la versión de API

Si una conexión de Shopify tiene actividades configuradas existentes, hay consideraciones adicionales que tomar en cuenta al cambiar la API Version seleccionada. Esto se debe a que los objetos y subobjetos disponibles para seleccionar en la configuración de actividad dependen de los endpoints de API que Shopify admite en la versión de API que se está utilizando. Si la configuración de actividad existente utiliza endpoints de API que no se admiten en la versión de API a la que estás cambiando, esas actividades fallarán a menos que se reconfiguren.

Para evitar que esto ocurra, sigue estos pasos:

1. Cambia la API version en la conexión de Shopify.

2. Abre cada pantalla de configuración de actividad donde se selecciona un objeto o subobjeto y haz clic en Refresh. Al actualizar, las listas de selección de objetos y subobjetos actuales se recuperarán usando la versión de API seleccionada en la conexión de Shopify. Ten en cuenta que Shopify redirige automáticamente las llamadas de versiones de API no admitidas a la versión admitida más antigua.

   Importante

   Si el objeto o subobjeto seleccionado no es compatible con la versión de API que se está llamando, la selección puede cambiar al actualizar. Presta atención para asegurarte de que cualquier cambio en las selecciones sea intencional.

3. Selecciona el objeto y subobjeto apropiados compatibles con la versión de API que se está llamando.

4. Redeploy las operaciones que usan la conexión y las actividades.

Próximos pasos

Después de crear una conexión de Shopify, colocas un tipo de actividad en el lienzo de diseño para crear instancias de actividad que se usen como orígenes (para proporcionar datos en una operación) o como destinos (para consumir datos en una operación).

Las acciones de menú para una conexión y sus tipos de actividad son accesibles desde el panel del proyecto y la paleta de componentes de diseño. Para obtener más detalles, consulta Menús de acciones en Conceptos básicos de conectores.

Estos tipos de actividad están disponibles:

• Read: Recupera datos de objetos de Shopify y está diseñado para usarse como origen en una operación.

• Query: Consulta datos de objetos de Shopify y está diseñado para usarse como origen en una operación.

• Create: Crea datos de objetos en Shopify y está diseñado para usarse como destino en una operación.

• Update: Actualiza datos de objetos en Shopify y está diseñado para usarse como destino en una operación.

• Delete: Elimina datos de objetos de Shopify y está diseñado para usarse como destino en una operación.