shopify_app

Aplicación Shopify

Esta gema construye aplicaciones Rails que se pueden integrar en el administrador de Shopify.

Introducción | Requisitos | Uso | Documentación | Contribuyente | Licencia

Introducción

Esta gema incluye un motor de rieles, generadores, módulos y mezclas que ayudan a crear aplicaciones de rieles que funcionan con las API de Shopify. El motor Shopify App Rails proporciona todo el código requerido para implementar OAuth con Shopify. El generador de aplicaciones de Shopify predeterminado crea una aplicación que puede integrarse en el administrador de Shopify y la asegura con tokens de sesión.

Requisitos

Para convertirse en un desarrollador de aplicaciones de Shopify, necesitará una cuenta de Shopify Partners. Explore los documentos de Shopify Dev para obtener más información sobre la construcción de aplicaciones Shopify.

Esta gema requiere que tenga las siguientes credenciales:

• Clave API de Shopify: la credencial de aplicación de la clave API especificada en el tablero de su Shopify Partners.
• Shopify API Secret: la credencial API Secret Key App Specified en el tablero de su Shopify Partners.

Uso

1. Para comenzar, cree una nueva aplicación Rails:

rails new my_shopify_app

2. Agregue la gema de la aplicación Shopify al archivo gem de la aplicación:

bundle add shopify_app

3. Deberá proporcionar varias variables de entorno a la aplicación. Hay una variedad de forma de hacer esto, pero para un entorno de desarrollo recomendamos la gema dotenv-rails . Cree un archivo .env en la aplicación Root of Your Rails para especificar las credenciales completas de la API de host y Shopify:

HOST=http://localhost:3000
SHOPIFY_API_KEY= < Your Shopify API key >
SHOPIFY_API_SECRET= < Your Shopify API secret >

4. Ejecute el generador de aplicaciones Shopify predeterminado para crear una aplicación que se pueda integrar en el administrador de Shopify:

rails generate shopify_app

5. Ejecute una migración para crear las tablas necesarias en su base de datos:

rails db:migrate

6. Ejecute la aplicación:

rails server

7. Dentro de Shopify Partners, navegue a su aplicación, luego la configuración de la aplicación y configure las URL, por ejemplo:

• URL de la aplicación: http: // localhost: 3000/
• URL (s) de redirección permitida: http: // localhost: 3000/auth/shopify/callback

8. Instale la aplicación visitando la URL del servidor (por ejemplo, http: // localhost: 3000) y especificando el subdominio de la tienda donde desea que se instale.

9. Después de instalar la aplicación, se redirige a la aplicación incrustada.

Esta aplicación implementa OAuth 2.0 con Shopify para autenticar las solicitudes hechas a las API de Shopify. De manera predeterminada, esta aplicación está configurada para usar tokens de sesión para autenticar a los comerciantes cuando se integran en el administrador de Shopify.

Consulte Generadores para obtener una lista completa de generadores disponibles para la aplicación Shopify.

Documentación

Puede encontrar documentación sobre el uso de gemas, los conceptos, las mezclas, la instalación y más en /docs .

• Comience con el documento de generadores para obtener más información sobre los generadores que ofrece esta gema.
• Echa un vistazo a ChangeLog para obtener notas sobre las últimas versiones de GEM.
• Consulte la resolución de problemas para obtener consejos sobre problemas comunes.
• Si está buscando actualizar su versión de la aplicación Shopify a una nueva versión importante, consulte Actualización de notas importantes sobre los cambios de ruptura.

Descripción general

Inicio rápido

Solución de problemas

Actualización

Aplicación Shopify

• Autenticación
• Motor
• Preocupaciones del controlador
• Generadores
• Sesiones
• Manejo de cambios en los ámbitos de acceso
• Pruebas
• Webhooks
• Política de seguridad de contenido
• Explotación florestal

Motor

El montaje del motor Shopify App Rails proporciona las siguientes rutas. Estas rutas están configuradas para ayudar a instalar su aplicación en las tiendas e implementar OAuth.

Verbo	Ruta	Acción
GET	/login	Acceso
POST	/login	Acceso
GET	/auth/shopify/callback	Oauth redirige uri
GET	/logout	Cierre de sesión
POST	/webhooks/:type	Devolución de llamada de Webhook

Estas rutas son configurables. Consulte la documentación del motor más detallada para saber cómo puede personalizar la URL de inicio de sesión o montar el motor de Rails de la aplicación Shopify en rutas anidadas.

Para obtener más información sobre cómo esta joya se autentica con Shopify, vea la autenticación .

Nueva estrategia de autorización de aplicaciones integradas (intercambio de tokens)

Consejo

Si está creando una aplicación integrada, recomendamos que utilice la instalación administrada de Shopify con Exchange de token en lugar del flujo de subvención del código de autorización heredado.

Hemos introducido una nueva estrategia de instalación y autorización para aplicaciones integradas que eliminan las redirecciones que eran previamente necesarias. Reemplaza el flujo de subvención del código de instalación y autorización existente.

Esto se logra mediante el uso de la instalación administrada de Shopify para manejar las instalaciones automáticas de aplicaciones y las actualizaciones de alcance, mientras utilizan el intercambio de tokens para recuperar un token de acceso para el acceso de API autenticado.

Habilitando esta nueva estrategia en su aplicación

1. Habilite la instalación administrada de Shopify configurando sus ámbitos a través de Shopify CLI.

Nota

Asegúrese de no tener use_legacy_install_flow = true en su archivo de configuración shopify.app.toml . Si use_legacy_install_flow es verdadero, Shopify no administrará el proceso de instalación para su aplicación. Debe eliminar la línea use_legacy_install_flow de su archivo de configuración shopify.app.toml o establecerlo en false .

2. Habilite la nueva estrategia de autenticación en el archivo de configuración ShopifyApp de su aplicación.

 # config/initializers/shopify_app.rb
ShopifyApp . configure do | config |
  #.....
  config . embedded_app = true
  config . new_embedded_auth_strategy = true

  # If your app is configured to use online sessions, you can enable session expiry date check so a new access token
  # is fetched automatically when the session expires.
  # See expiry date check docs: https://github.com/Shopify/shopify_app/blob/main/docs/shopify_app/sessions.md#expiry-date
  config . check_session_expiry_date = true
  ...
end

3. Manejar la lógica especial de devolución de llamada. Si su aplicación ha anulado el OAuth CallbackController para ejecutar tareas especiales después de la autorización, deberá crear y configurar una clase personalizada de PostAuthentATateSks para ejecutar estas tareas después del intercambio de tokens. El OAuth CallbackController original ya no se activará. Consulte la documentación de Tareas Post Authenticate para obtener más información.
4. Asegúrese de que su diseño embedded_app sea correcto. Si su aplicación tiene algún controlador que incluya ShopifyApp::EnsureInstalled , ahora también incluirá la preocupación ShopifyApp::EmbeddedApp , que establece layout 'embedded_app' para el controlador actual de forma predeterminada. En los casos en que el controlador buscó originalmente otro archivo de diseño, esto puede causar un comportamiento inesperado. Consulte la documentación de EmbeddedApp en preocupación para obtener más información sobre los efectos de esta preocupación y cómo deshabilitar el cambio de diseño si es necesario.
5. Disfrute de un proceso de instalación de aplicaciones más suave y más rápido.

Versión de API

La API de Shopify está versión. Con Shopify App v1.11.0 , la GEM API Shopify incluida permite a los desarrolladores especificar y actualizar la versión de la API de Shopify que desean que su aplicación o servicio use. La gema de la API de Shopify también superficie las advertencias de las aplicaciones de Rails sobre puntos finales desapercibidos, campos GraphQL y más.

Consulte el Readme de Gem Shopify API para obtener más información.