該庫為Ruby Shopify應用程序提供了支持,可以通過更容易執行以下操作來訪問Shopify Admin API:
除了管理API外,此庫還允許查詢店面API。
您可以在具有Ruby Backend的任何應用程序中使用此庫,因為它不依賴於任何特定的框架 - 您可以將其包含在首選的堆棧並附上,並使用構建應用程序所需的功能。
注意:這些說明適用於此軟件包的V10或更晚。如果您在應用程序中運行V9,則可以在此分支中找到文檔。
如果在Rails框架中使用,我們強烈建議您使用Shopify_app Gem與此寶石進行交互。身份驗證,會話存儲,Webhook註冊和其他經常實現的路徑在該寶石中使用易於使用的配置進行管理。
要遵循這些使用指南,您將需要:
將以下內容添加到您的Gemfile:
gem " shopify_api "
或使用Bundler:
bundle add shopify_api
首先,通過調用Shopifyapi :: ShopifyAPI::Context.setup
ShopifyAPI::Context
,當您的應用程序啟動時(例如,在Rails App中的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 Doc。
如果您打算在應用程序中使用Webhooks,請按照Webhooks文檔中的步驟進行註冊和處理Webhooks的說明。
一旦您的應用程序可以執行OAuth,它現在就可以進行身份驗證的Shopify API呼叫,請參閱文檔:
請參閱breaking_changes_for_v15
請參閱breaking_changes_for_v10
請參閱breaking_changes_for_older_versions
克隆存儲庫後,您可以使用Bundler安裝依賴項:
bundle install
運行自動測試:
bundle exec rake test
我們使用rubocop來覆蓋/格式化代碼。您可以使用以下命令運行它:
bundle exec rubocop