Téléchargement shopify api ruby shopify api ruby Code source Ruby API Shopify Download

shopify api ruby

Autre code source

Télécharger

Bibliothèque API Shopify pour Ruby

Statut de construction

Cette bibliothèque prend en charge les applications Ruby Shopify pour accéder à l'API Admin Shopify, en facilitant l'exécution des actions suivantes:

Création de jetons d'accès en ligne ou hors ligne pour l'API Admin via OAuth
Faire des demandes à l'API de repos
Faire des demandes à l'API GraphQL
Enregistrement / traitement des webhooks

En plus de l'API ADMIN, cette bibliothèque permet également d'interroger l'API de devanture.

Vous pouvez utiliser cette bibliothèque dans n'importe quelle application qui a un backend Ruby, car elle ne s'appuie pas sur un cadre spécifique - vous pouvez l'inclure aux côtés de votre pile préférée et utiliser les fonctionnalités dont vous avez besoin pour créer votre application.

Remarque : Ces instructions s'appliquent à V10 ou ultérieurement de ce package. Si vous exécutez V9 dans votre application, vous pouvez trouver la documentation dans cette branche.

Utiliser avec les rails

Si vous utilisez dans le cadre des rails, nous vous recommandons fortement d'utiliser le Gem Shopify_App pour interagir avec ce joyau. L'authentification, le stockage de session, l'enregistrement Webhook et d'autres chemins fréquemment implémentés sont gérés dans ce gemme avec des configurations faciles à utiliser.

Exigences

Pour suivre ces guides d'utilisation, vous devrez:

avoir une connaissance pratique de Ruby et un cadre Web tel que Rails ou Sinatra
Avoir un magasin de comptes et de développement de partenaire Shopify
avoir une application déjà configurée dans votre magasin de tests ou votre compte partenaire
Ajoutez l'URL et la redirection appropriée pour votre route de rappel OAuth vers les paramètres de votre application

Installation

Ajoutez ce qui suit à votre gemfile:

gem " shopify_api "

ou utilisez Bundler:

bundle add shopify_api

Étapes pour utiliser le gemme

Configurer le contexte Shopify

Commencez par initialiser le ShopifyAPI::Context avec les paramètres de votre application en appelant ShopifyAPI::Context.setup (Exemple ci-dessous) lorsque votre application démarre (par exemple, application.rb dans une application Rails).

 ShopifyAPI :: Context . setup (
  api_key : "<api-key>" ,
  api_secret_key : "<api-secret-key>" ,
  host : "<https://application-host-name.com>" ,
  scope : "read_orders,read_products,etc" ,
  is_embedded : true , # Set to true if you are building an embedded app
  api_version : "2022-01" , # The version of the API you would like to use
  is_private : false , # Set to true if you have an existing private app
)

Effectuer OAuth

Vous devez passer par OAuth comme décrit ici pour créer des séances pour les magasins utilisant votre application. Le Gem Gem Shopify API essaie de faciliter cela en fournissant des fonctions pour commencer et terminer le processus OAuth. Voir le DOC OAuth pour des instructions sur la façon de les utiliser.

Enregistrer les webhooks et un gestionnaire de webhook

Si vous avez l'intention d'utiliser des webhooks dans votre application, suivez les étapes du document Webhooks pour des instructions sur l'enregistrement et la gestion de webhooks.