shopify_app下載shopify_app源代碼下載

shopify_app

其他源碼

v22.4.0

下載

Shopify應用程序

該寶石構建了可以嵌入Shopify管理員的Rails應用程序。

簡介|要求|用法|文檔|貢獻|執照

介紹

該寶石包括鐵軌引擎，發電機，模塊和混合物，可幫助創建與Shopify API一起使用的導軌應用程序。 Shopify App Rails引擎提供了與Shopify實施OAuth所需的所有代碼。默認的Shopify App Generator構建了一個可以嵌入Shopify Admin並使用Session令牌確保的應用程序。

要求

要成為Shopify應用程序開發人員，您將需要一個Shopify Partners帳戶。探索Shopify開發文檔，以了解有關構建Shopify應用程序的更多信息。

該寶石要求您具有以下憑據：

Shopify API密鑰：您的Shopify Partners儀表板中指定的API密鑰APP憑據。
Shopify API Secret： API秘密密鑰應用程序憑證在您的Shopify Partners儀表板中指定。

用法

首先，創建一個新的Rails應用程序：

rails new my_shopify_app

將Shopify App Gem添加到應用程序的Gemfile：

bundle add shopify_app

您將需要為應用程序提供多個環境變量。有多種方法可以做到這一點，但是對於開發環境，我們推薦了dotenv-rails Gem。在您的Rails應用程序的根部創建.env文件，以指定完整的主機和Shopify API憑據：

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

運行默認的Shopify應用程序生成器以創建可以嵌入Shopify Admin的應用程序：

rails generate shopify_app

運行遷移以在數據庫中創建必要的表：

rails db:migrate

運行應用程序：

rails server

在Shopify Partners中，導航到您的應用程序，然後進行應用程序設置，並配置URL，例如：

應用網址：http：// localhost：3000/
允許的重定向URL：http：// localhost：3000/auth/shopify/callback

通過訪問服務器的URL來安裝應用程序（例如http：// localhost：3000），並指定您希望將其安裝到的商店的子域。
安裝應用程序後，您將您重定向到嵌入式應用程序。

該應用程序通過Shopify實施Oauth 2.0，以驗證對Shopify API提出的請求。默認情況下，此應用程序被配置為使用Session代幣在Shopify Admin中嵌入商人身份驗證商人。

有關可用於Shopify應用程序的發電機的完整列表，請參見發電機。

文件

您可以找到有關GEM使用，概念，混音，安裝等/docs的文檔。

從發電機文檔開始，以了解有關此GEM提供的發電機的更多信息。
查看ChangElog上有關最新寶石發行的註釋。
有關常見問題的提示，請參見故障排除。
如果您希望將Shopify App版本升級到新的主要版本，請參閱有關破壞更改的重要說明。

概述

Quickstart

故障排除

升級

Shopify應用程序

驗證
引擎
控制器問題
發電機
會議
處理訪問範圍的變化
測試
Webhooks
內容安全策略
記錄

引擎

安裝Shopify App Rails發動機提供以下路線。這些路線被配置為幫助將您的應用程序安裝在商店並實施OAuth。

動詞	路線	行動
`GET`	`/login`	登入
`POST`	`/login`	登入
`GET`	`/auth/shopify/callback`	Oauth重定向URI
`GET`	`/logout`	註銷
`POST`	`/webhooks/:type`	Webhook回調

這些路線是可配置的。請參閱更詳細的引擎文檔，以了解如何自定義登錄網址或在嵌套路線上安裝Shopify App Rails引擎。

要了解有關該寶石如何使用Shopify進行認證的更多信息，請參閱身份驗證。

新的嵌入式應用授權策略（令牌交換）

提示

如果您要構建一個嵌入式應用程序，我們強烈建議將Shopify託管安裝與代幣交易所使用，而不是傳統的授權代碼贈款流。

我們為嵌入式應用程序引入了一種新的安裝和授權策略，以消除以前必要的重定向。它取代了現有的安裝和授權代碼授予流。

這是通過使用Shopify託管安裝來處理自動應用程序安裝和範圍更新的，同時利用令牌交換來檢索訪問令牌以進行身份驗證的API訪問。

在您的應用中啟用這種新策略

通過Shopify CLI配置示波器來啟用Shopify託管安裝。

筆記

確保您在shopify.app.toml配置文件中沒有use_legacy_install_flow = true 。如果use_legacy_install_flow為真，則Shopify將無法管理應用程序的安裝過程。您應該從shopify.app.toml配置文件中刪除use_legacy_install_flow LINE或將其設置為false 。

在您的應用程序的ShopifyApp配置文件中啟用新的auth策略。

 # 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

處理特殊回調邏輯。如果您的應用程序已將OAuth CallbackController覆蓋以運行特殊任務後，則您需要創建和配置自定義的postauthenticateTasks類，以在代幣交換後運行這些任務。原始的OAuth CallbackController將不再觸發。有關更多信息，請參見郵政身份驗證的任務文檔。
確保您的embedded_app佈局正確。如果您的應用程序具有任何控制器，其中包括ShopifyApp::EnsureInstalled ，則現在還將包括ShopifyApp::EmbeddedApp Confort，默認情況下為當前控制器設置了layout 'embedded_app' 。如果控制器最初尋找另一個佈局文件，則可能會導致意外行為。有關此關注的效果以及如何在需要時禁用佈局更改的更多信息，請參見EmbeddedApp Confort的文檔。
享受更流暢，更快的應用程序安裝過程。