shopify_app

Application Shopify

Cette gemme construit des applications de rails qui peuvent être intégrées dans l'administrateur Shopify.

Introduction | Exigences | Utilisation | Documentation | Contribution | Licence

Introduction

Ce joyau comprend un moteur de rails, des générateurs, des modules et des mixins qui aident à créer des applications rails qui fonctionnent avec des API Shopify. Le moteur Shopify App Rails fournit tout le code requis pour implémenter OAuth avec Shopify. Le générateur d'applications Shopify par défaut construit une application qui peut être intégrée dans l'administrateur Shopify et la sécurise avec des jetons de session.

Exigences

Pour devenir un développeur d'applications Shopify, vous aurez besoin d'un compte Shopify Partners. Explorez les Docs Shopify pour en savoir plus sur la création d'applications Shopify.

Ce joyau nécessite que vous ayez les informations d'identification suivantes:

• Clé API Shopify: l'identification de l'application API Key spécifiée dans votre tableau de bord Shopify Partners.
• Shopify API Secret: L'identification de l'application API Secret Key spécifiée dans votre tableau de bord Shopify Partners.

Usage

1. Pour commencer, créez une nouvelle application Rails:

rails new my_shopify_app

2. Ajoutez le gemm de l'application Shopify au gemfile de l'application:

bundle add shopify_app

3. Vous devrez fournir plusieurs variables d'environnement à l'application. Il existe une variété de moyens de le faire, mais pour un environnement de développement, nous avons recommandé le gemme dotenv-rails . Créez un fichier .env dans la racine de votre application Rails pour spécifier l'hôte complet et les informations d'identification API:

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

4. Exécutez le générateur d'application Shopify par défaut pour créer une application qui peut être intégrée dans l'administrateur Shopify:

rails generate shopify_app

5. Exécutez une migration pour créer les tables nécessaires dans votre base de données:

rails db:migrate

6. Exécutez l'application:

rails server

7. Dans Shopify Partners, accédez à votre application, puis configuration de l'application et configurez les URL, par exemple:

• URL de l'application: http: // localhost: 3000 /
• URL de redirection autorisée (s): http: // localhost: 3000 / auth / shopify / rappel

8. Installez l'application en visitant l'URL du serveur (par exemple http: // localhost: 3000) et spécifiant le sous-domaine de la boutique où vous souhaitez qu'il soit installé.

9. Une fois l'application installée, vous êtes redirigé vers l'application intégrée.

Cette application implémente OAuth 2.0 avec Shopify pour authentifier les demandes faites pour Shopify API. Par défaut, cette application est configurée pour utiliser les jetons de session pour authentifier les marchands lorsqu'il est intégré dans l'administrateur Shopify.

Voir les générateurs pour une liste complète des générateurs disponibles pour Shopify App.

Documentation

Vous pouvez trouver une documentation sur l'utilisation des gemmes, les concepts, les mixins, l'installation et plus dans /docs .

• Commencez par le document des générateurs pour en savoir plus sur les générateurs que ce gemme offre.
• Consultez le Changelog pour les notes sur les dernières versions de gemmes.
• Voir le dépannage des conseils sur les problèmes communs.
• Si vous cherchez à mettre à niveau votre version de l'application Shopify vers une nouvelle version majeure, consultez la mise à niveau des notes importantes sur les modifications de rupture.

Aperçu

Start

Dépannage

Mise à niveau

Application Shopify

• Authentification
• Moteur
• Préoccupations du contrôleur
• Générateurs
• Séances
• Gestion des modifications des lunettes d'accès
• Essai
• Webhooks
• Politique de sécurité du contenu
• Enregistrement

Moteur

Le montage du moteur Shopify App Rails fournit les itinéraires suivants. Ces itinéraires sont configurés pour aider à installer votre application sur les magasins et à implémenter OAuth.

Verbe	Itinéraire	Action
GET	/login	Se connecter
POST	/login	Se connecter
GET	/auth/shopify/callback	Oauth rediriger uri
GET	/logout	Déconnexion
POST	/webhooks/:type	Rappel de webhook

Ces itinéraires sont configurables. Voir la documentation plus détaillée du moteur pour savoir comment vous pouvez personnaliser l'URL de connexion ou monter le moteur des rails d'application Shopify sur les routes imbriquées.

Pour en savoir plus sur la façon dont ce joyau s'authentifie avec Shopify, voir l'authentification .

Nouvelle stratégie d'autorisation d'application intégrée (échange de jetons)

Conseil

Si vous créez une application intégrée, nous recommandons fortement d'utiliser l'installation gérée de Shopify avec un échange de jetons au lieu du flux de subvention du code d'autorisation hérité.

Nous avons introduit une nouvelle stratégie d'installation et d'autorisation pour les applications intégrées qui éliminent les redirections qui étaient auparavant nécessaires. Il remplace le flux de subvention de code d'installation et d'autorisation existant.

Ceci est réalisé en utilisant l'installation gérée de Shopify pour gérer les installations automatiques d'applications et les mises à jour de la portée, tout en utilisant l'échange de jetons pour récupérer un jeton d'accès pour un accès API authentifié.

Activer cette nouvelle stratégie dans votre application

1. Activez l'installation gérée Shopify en configurant vos portées via le CLI Shopify.

Note

Assurez-vous que vous n'avez pas use_legacy_install_flow = true dans votre fichier de configuration shopify.app.toml . Si use_legacy_install_flow est vrai, Shopify ne gérera pas le processus d'installation de votre application. Vous devez supprimer la ligne use_legacy_install_flow de votre fichier de configuration shopify.app.toml ou le définir sur false .

2. Activez la nouvelle stratégie Auth dans le fichier de configuration ShopifyApp de votre application.

 # 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. Gérer la logique de rappel spéciale. Si votre application a remplacé l'autorisation de CallBackController OAuth pour exécuter des tâches spéciales après l'autorisation, vous devrez créer et configurer une classe postaThenticateTasks personnalisée pour exécuter ces tâches après l'échange de jetons. L'OAuth CallbackController d'origine ne sera plus déclenché. Voir la documentation des tâches d'authentification du post pour plus d'informations.
4. Assurez-vous que votre disposition embedded_app est correcte. Si votre application dispose d'un contrôleur qui comprend ShopifyApp::EnsureInstalled , il inclura désormais également la préoccupation ShopifyApp::EmbeddedApp , qui définit layout 'embedded_app' pour le contrôleur actuel par défaut. Dans les cas où le contrôleur recherchait à l'origine un autre fichier de mise en page, cela peut provoquer un comportement inattendu. Voir la documentation de EmbeddedApp Concern pour plus d'informations sur les effets de cette préoccupation et comment désactiver le changement de mise en page si nécessaire.
5. Profitez d'un processus d'installation d'applications plus lisse et plus rapide.

Version de l'API

L'API de Shopify est versée. Avec Shopify App v1.11.0 , le GEM API Shopify inclus permet aux développeurs de spécifier et de mettre à jour la version API Shopify qu'ils souhaitent que leur application ou leur service utilisent. Le gemme API Shopify fait également surface d'avertissements aux applications Rails sur les points de terminaison obsolètes, les champs GraphQL et plus encore.

Voir le Shopify API Gem Readme pour plus d'informations.