Conexión de Shopify en Jitterbit Studio

Introducción

Una conexión de Shopify, creada utilizando 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 con esa conexión para ser utilizadas como fuentes (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 utilizando el conector de Shopify desde una de estas ubicaciones:

• La pestaña Puntos finales y conectores del componente de diseño en la paleta de componentes de diseño (ver Paleta de componentes de diseño).
• La página de Puntos finales globales (ver Crear un punto final global en Puntos finales globales).

Una conexión de Shopify existente se puede editar desde estas ubicaciones:

• La pestaña Puntos finales y conectores del componente de diseño en la paleta de componentes de diseño (ver Paleta de componentes de diseño).
• La pestaña Componentes del panel del proyecto (ver Menú de acciones del componente en Pestaña de componentes del panel del proyecto).
• La página de Puntos finales globales (ver Editar un punto final global en Puntos finales globales).

Configurar una conexión de Shopify

Cada elemento de la interfaz de usuario de la pantalla de configuración de la conexión de Shopify se describe a continuación.

La interfaz utilizada en la configuración de conexión de Shopify depende de la opción seleccionada en Mecanismo de autenticación:

• Autenticación basada en credenciales: Para esta opción, la conexión se autentica utilizando credenciales de API para su tienda Shopify.

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

Autenticación basada en credenciales

Cuando se selecciona Autenticación basada en credenciales como el Mecanismo de autenticación, se presenta la interfaz descrita a continuación.

• Nombre de la conexión: Ingrese 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 punto final de Shopify, que se refiere tanto a una conexión específica como a sus actividades.

• Nombre de la tienda: Ingrese el nombre de la tienda Shopify.

• Mecanismo de autenticación: Seleccione Autenticación basada en credenciales para autenticar utilizando credenciales de API.

• Tipo de autenticación: Seleccione el tipo de autenticación, uno de Autenticación básica o Token de acceso de Shopify. Si está utilizando una aplicación privada, seleccione Autenticación básica. Si está utilizando una aplicación personalizada creada en el administrador de Shopify, seleccione Token de acceso de Shopify.

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

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

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

• Configuraciones opcionales: Haga clic para expandir configuraciones adicionales:

  • Usar configuraciones de proxy (Solo agente privado): Al usar un agente privado, se puede seleccionar esta configuración para utilizar configuraciones de proxy de agente privado.

  • Versión API: Seleccione la versión de la API REST Admin de Shopify, una de 2022-04 (predeterminado), 2023-01, 2023-04, 2023-07, 2023-10, 2024-01, 2024-04, 2024-07, 2024-10, 2025-01, 2025-04, 2025-07, 2025-10, o 2026-04. Dependiendo de los endpoints de API soportados por Shopify en la versión de API que se esté utilizando, los objetos y sub-objetos que están disponibles para selección durante la configuración de actividades pueden variar. Si se cambia la Versión API para una conexión que tiene actividades configuradas existentes, consulte 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 una versión de API es descontinuada, Shopify ya no mantendrá esa versión, y cualquier llamada API que solicite esa versión será automáticamente redirigida a la versión estable más antigua actualmente soportada.

    Shopify puede descontinuar ciertos endpoints con la introducción de una nueva versión de API. Como resultado, es posible que necesite cambiar sus aplicaciones y configuraciones de actividad debido a características cambiadas o retiradas.

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

  • Encabezados de Solicitud: Utiliza esta tabla para agregar cualquier par clave-valor que se enviará 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 nueva fila o cualquier edición realizada en una fila existente. Visible al pasar el cursor sobre una fila en modo de edición.
    • Editar: 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.
    • Limpiar Todo: Elimina todas las filas de la tabla.

    Importante

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

    Los campos en la tabla de 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 en los campos directamente, escapa el contenido JSON antes de pasarlo con una variable. Por ejemplo, escapar {"success": "true"}; se convierte en {\"success\": \"true\"};.

• Probar: Haz clic para verificar la conexión utilizando la configuración proporcionada. Cuando se prueba la conexión, la última versión del conector es descargada por el(los) agente(s) en el grupo de agentes asociado con el entorno actual. Este conector admite suspender la descarga de la última versión del conector utilizando la política de organización Deshabilitar Actualización Automática del Conector.

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

• Descartar cambios: Después de realizar cambios en una configuración nueva o existente, haga clic para cerrar la configuración sin guardar. Un mensaje le pide que confirme que desea descartar los cambios.

• Eliminar: Después de abrir una configuración de conexión existente, haga clic para eliminar permanentemente la conexión del proyecto y cerrar la configuración (consulte Dependencias de componentes, eliminación y remoción). Un mensaje le pide que confirme que desea 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, consulte Notas importantes.

• Nombre de la conexión: Ingrese 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 punto final de Shopify, que se refiere tanto a una conexión específica como a sus actividades.

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

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

• Aplicación OAuth: Usa el menú para seleccionar una aplicación OAuth 2.0 bajo Aplicaciones Privadas. Esta categoría muestra las aplicaciones de conector de Shopify configuradas en la página de Registro de Aplicaciones de la Consola de Administración. Para más información sobre cómo configurar una aplicación de conector de Shopify en la página de Registro de Aplicaciones, consulta Requisitos Previos.

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

• Configuraciones opcionales: Haz clic para expandir configuraciones adicionales:

  • Usar Configuraciones de Proxy (Solo Agente Privado): Al usar un agente privado, se puede seleccionar esta configuración para usar configuraciones de proxy de agente privado.

  • Versión de API: Selecciona la versión de API REST Admin de Shopify, 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, o 2026-04. Dependiendo de los puntos finales de API soportados por Shopify en la versión de API que se esté utilizando, los objetos y sub-objetos que están disponibles para selección 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 una versión de API es descontinuada, Shopify ya no mantendrá esa versión, y cualquier llamada a la API que solicite esa versión será automáticamente redirigida a la versión estable más antigua actualmente soportada.

    Shopify puede descontinuar ciertos endpoints con la introducción de una nueva versión de la API. Como resultado, es posible que necesites cambiar tus aplicaciones y configuraciones de actividad debido a características cambiadas o retiradas.

    Las versiones y endpoints de API descontinuados se anuncian en el registro de cambios de Shopify, donde están disponibles más detalles y cualquier información relevante sobre migración.

  • Encabezados de Solicitud: Usa esta tabla para agregar cualquier par clave-valor que se enviará 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 nueva fila o cualquier edición realizada en una fila existente. Visible al pasar el cursor sobre una fila en modo de edición.
    • Editar: 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.
    • Limpiar Todo: Elimina todas las filas de la tabla.

    Importante

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

    Los campos en la tabla de 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 en los campos directamente, escapa el contenido JSON antes de pasarlo con una variable. Por ejemplo, escapar {"success": "true"}; se convierte en {\"success\": \"true\"};.

• Probar: Haz clic para verificar la conexión utilizando la configuración proporcionada. Cuando se prueba la conexión, la última versión del conector es descargada por el(los) agente(s) en el grupo de agentes asociado con el entorno actual. Este conector admite suspender la descarga de la última versión del conector utilizando la política de organización Deshabilitar Actualización Automática del Conector.

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

• Descartar cambios: Después de realizar cambios en una configuración nueva o existente, haga clic para cerrar la configuración sin guardar. Un mensaje le pide que confirme que desea descartar los cambios.

• Eliminar: Después de abrir una configuración de conexión existente, haga clic para eliminar permanentemente la conexión del proyecto y cerrar la configuración (consulte Dependencias de componentes, eliminación y remoción). Un mensaje le pide que confirme que desea eliminar la conexión.

Cambiar la versión de la API

Si una conexión de Shopify tiene actividades configuradas existentes, hay consideraciones adicionales a tener en cuenta al cambiar la versión de la API seleccionada. Esto se debe a que los objetos y sub-objetos disponibles para selección en la configuración de la actividad dependen de los puntos finales de la API que Shopify admite en la versión de la API que se está utilizando. Si la configuración de actividad existente utiliza puntos finales de la API que no son compatibles con la versión de la API a la que está cambiando, entonces esas actividades fallarán a menos que se reconfiguren.

Para evitar que esto ocurra, siga estos pasos:

1. Cambie la versión de la API en la conexión de Shopify.

2. Abra cada pantalla de configuración de actividad donde se seleccione un objeto o sub-objeto y haga clic en Actualizar. Al actualizar, se recuperarán las listas de selección de objeto y sub-objeto actuales utilizando la versión de la API seleccionada en la conexión de Shopify. Tenga en cuenta que Shopify redirige automáticamente las llamadas de versiones de API no compatibles a la siguiente versión compatible más antigua.

   Importante

   Si el objeto o sub-objeto seleccionado no es compatible con la versión de la API que se está llamando, la selección puede cambiar al actualizar. Preste mucha atención para asegurarse de que cualquier selección cambiada sea la deseada.

3. Seleccione el objeto y sub-objeto apropiados compatibles con la versión de la API que se está llamando.

4. Reimplementación de operaciones utilizando la conexión y actividades.

Próximos pasos

Después de que se ha creado una conexión de Shopify, se coloca un tipo de actividad en el lienzo de diseño para crear instancias de actividad que se utilizarán como fuentes (para proporcionar datos en una operación) o como destinos (para consumir datos en una operación).

Las acciones del 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 más detalles, consulta los menús de acciones en Conceptos básicos del conector.

Estos tipos de actividad están disponibles:

• Leer: Recupera datos de objetos de Shopify y está destinado a ser utilizado como fuente en una operación.

• Consultar: Consulta datos de objetos de Shopify y está destinado a ser utilizado como fuente en una operación.

• Crear: Crea datos de objetos en Shopify y está destinado a ser utilizado como destino en una operación.

• Actualizar: Actualiza datos de objetos en Shopify y está destinado a ser utilizado como destino en una operación.

• Eliminar: Elimina datos de objetos de Shopify y está destinado a ser utilizado como destino en una operación.