该库为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