このライブラリは、次のアクションを簡単に実行できるようにすることにより、Shopify Admin APIにアクセスするためのRuby Shopifyアプリのサポートを提供します。
Admin APIに加えて、このライブラリでは、ストアフロントAPIをクエリすることもできます。
このライブラリは、特定のフレームワークに依存していないため、Rubyバックエンドの任意のアプリケーションで使用できます。お好みのスタックと一緒に含めて、アプリを構築するために必要な機能を使用できます。
注：これらの手順は、このパッケージのV10以降に適用されます。アプリでV9を実行している場合は、このブランチでドキュメントを見つけることができます。
Railsフレームワークで使用する場合は、Shopify_App GEMを使用してこの宝石と対話することを強くお勧めします。認証、セッションストレージ、WebHook登録、およびその他の頻繁に実装されたパスは、使いやすい構成を備えたGEMで管理されます。
これらの使用ガイドに従うには、次のことが必要です。
gemfileに次のものを追加します。
gem " shopify_api "またはバンドラーを使用します：
bundle add shopify_apiShopifyAPI::Context with Your Appのパラメーターを使用することから始めます。Shopifyapi ShopifyAPI::Context.setup （以下の例）を呼び出して、アプリが起動したときに（Railsアプリのapplication.rbなど）。
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を通過する必要があります。 Shopify API GEMは、OAuthプロセスを開始および完了する機能を提供することにより、これを簡単にしようとします。これらの使用方法については、OAUTHドキュメントを参照してください。
アプリケーションでWebhooksを使用する場合は、Webhooksの登録と取り扱いの指示については、WebHooksドキュメントの手順に従ってください。
アプリがOAuthを実行できるようになったら、認証されたShopify API呼び出しを作成できます。
breaking_changes_for_v15を参照してください
breaking_changes_for_v10を参照してください
breaking_changes_for_older_versionsを参照してください
リポジトリをクローニングした後、バンドラーで依存関係をインストールできます。
bundle install自動テストを実行するには：
bundle exec rake testRubocopを使用して、コードを並べ/フォーマットします。次のコマンドで実行できます。
bundle exec rubocop
