Shopify App 技术文档

1. 安装指南

1.1 环境要求

• 你需要一个 Shopify Partners 账户。
• 确保你已经获取了以下凭证：
  • Shopify API key：在 Shopify Partners 仪表板中指定的 API 密钥。
  • Shopify API secret：在 Shopify Partners 仪表板中指定的 API 密钥。

1.2 安装步骤

1. 创建一个新的 Rails 应用：

   rails new my_shopify_app
   

2. 在应用的 Gemfile 中添加 Shopify App gem：

   bundle add shopify_app
   

3. 配置环境变量： 推荐使用 dotenv-rails gem 来管理开发环境中的环境变量。在 Rails 应用的根目录下创建一个 .env 文件，并指定以下内容：

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

4. 运行默认的 Shopify App 生成器：

   rails generate shopify_app
   

5. 运行数据库迁移：

   rails db:migrate
   

6. 启动应用：

   rails server
   

7. 在 Shopify Partners 中配置应用的 URL：

   • App URL: http://localhost:3000/
   • Allowed redirection URL(s): http://localhost:3000/auth/shopify/callback

8. 访问应用的 URL（例如 http://localhost:3000）并指定要安装应用的商店子域名。

9. 安装完成后，你将被重定向到嵌入式应用。

2. 项目使用说明

2.1 嵌入式应用

该应用通过 OAuth 2.0 与 Shopify 进行身份验证，并使用会话令牌来验证嵌入在 Shopify Admin 中的商户请求。

2.2 生成器

Shopify App gem 提供了多个生成器，帮助你快速创建和配置应用。详细信息请参阅 生成器文档。

3. 项目API使用文档

3.1 路由配置

Shopify App Rails Engine 提供了以下路由，用于帮助安装应用并实现 OAuth：

请求方法	路由	动作
GET	/login	登录
POST	/login	登录
GET	/auth/shopify/callback	OAuth 重定向 URI
GET	/logout	登出
POST	/webhooks/:type	Webhook 回调

3.2 新嵌入式应用授权策略

Shopify 引入了一种新的安装和授权策略，适用于嵌入式应用。该策略通过 Shopify 托管安装和令牌交换来实现，消除了之前必要的重定向。

启用新策略

1. 通过 Shopify CLI 配置范围，启用 Shopify 托管安装。
2. 在应用的 ShopifyApp 配置文件中启用新授权策略：

   ShopifyApp.configure do |config|
     config.embedded_app = true
     config.new_embedded_auth_strategy = true
     config.check_session_expiry_date = true
   end
   

3. 处理特殊回调逻辑。

4. 项目安装方式

4.1 通过生成器安装

使用 rails generate shopify_app 命令可以快速生成一个嵌入式应用，并自动配置 OAuth 和会话令牌。

4.2 手动配置

你也可以手动配置应用，包括设置环境变量、配置路由和处理 OAuth 回调。

---

通过以上文档，你应该能够顺利安装和使用 Shopify App gem 来构建嵌入式应用。如果有任何问题，请参考 故障排除 或 升级指南。