shopify api ruby Download - shopify api ruby Source Code Download

shopify api ruby

Anderer Quellcode

Herunterladen

Shopify API Library für Ruby

Status erstellen

Diese Bibliothek bietet Ruby Shopify -Apps für den Zugriff auf die Shopify -Administrator -API und erleichtert die Ausführung der folgenden Aktionen:

Erstellen von Online- oder Offline -Zugriffstoken für die Admin -API über OAuth
Anfragen an die Rest -API stellen
Anfragen an der GraphQL -API machen
Registrieren/Verarbeitung von Webhooks

Zusätzlich zur Admin -API ermöglicht diese Bibliothek auch das Abfragen der StoreFront -API.

Sie können diese Bibliothek in jeder Anwendung mit einem Ruby -Backend verwenden, da sie nicht auf ein bestimmtes Framework beruht. Sie können sie neben Ihrem bevorzugten Stapel einfügen und die Funktionen verwenden, die Sie zum Erstellen Ihrer App benötigen.

Hinweis : Diese Anweisungen gelten für V10 oder später dieses Pakets. Wenn Sie V9 in Ihrer App ausführen, finden Sie die Dokumentation in dieser Filiale.

Verwendung mit Schienen

Wenn wir im Rails -Framework verwendet werden, empfehlen wir Ihnen dringend, das Edelstein für Shopify_App zu verwenden, um mit diesem Juwel zu interagieren. Authentifizierung, Sitzungspeicher, Webhook -Registrierung und andere häufig implementierte Pfade werden in diesem Juwel mit einfach zu verwendenden Konfigurationen verwaltet.

Anforderungen

Um diesen Nutzungsleitfäden zu folgen, müssen Sie:

Machen Sie Kenntnisse über Ruby und ein Web -Framework wie Schienen oder Sinatra
Haben Sie ein Shopify -Partnerkonto und ein Entwicklungsgeschäft
Lassen Sie bereits eine App in Ihrem Testgeschäft oder Partnerkonto einrichten
Fügen Sie die URL und die entsprechende Weiterleitung für Ihre OAuth -Callback -Route zu Ihren App -Einstellungen hinzu

Installation

Fügen Sie Ihrem GemFile Folgendes hinzu:

gem " shopify_api "

Oder verwenden Sie Bundler:

bundle add shopify_api

Schritte zur Verwendung des Edelsteins

Setup Shopify Context

Beginnen Sie mit den Parametern Ihrer App, indem Sie ShopifyAPI::Context.setup (Beispiel unten), wenn Ihre App startet (z. B. application.rb in einer Schienen -App), mit den ShopifyAPI::Context Ihrer App initialisieren.

 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
)

OAuth ausführen

Sie müssen OAuth wie beschrieben durchgehen, um Sitzungen für Geschäfte mit Ihrer App zu erstellen. Das Shopify -API -Edelstein versucht, dies zu vereinfachen, indem sie Funktionen bereitstellen, um den OAuth -Prozess zu beginnen und abzuschließen. In dem OAuth -DOC finden Sie Anweisungen zur Verwendung dieser.

Registrieren Sie Webhooks und einen Webhook -Handler

Wenn Sie die Webhooks in Ihrer Anwendung verwenden möchten, befolgen Sie die Schritte im Webhooks -DOC für Anweisungen zum Registrieren und Umgang mit Webhooks.

Erstellen Sie authentifizierte Shopify -API -Anfragen

Sobald Ihre App OAuth ausführen kann, kann sie jetzt authentifizierte Shopify -API -Anrufe tätigen. Weitere Informationen finden Sie in den Dokumenten: