Shopify App 技术文档
2024-12-23 00:32:25作者:庞队千Virginia
1. 安装指南
1.1 环境要求
- 你需要一个 Shopify Partners 账户。
- 确保你已经获取了以下凭证:
- Shopify API key:在 Shopify Partners 仪表板中指定的 API 密钥。
- Shopify API secret:在 Shopify Partners 仪表板中指定的 API 密钥。
1.2 安装步骤
-
创建一个新的 Rails 应用:
rails new my_shopify_app
-
在应用的 Gemfile 中添加 Shopify App gem:
bundle add shopify_app
-
配置环境变量: 推荐使用
dotenv-rails
gem 来管理开发环境中的环境变量。在 Rails 应用的根目录下创建一个.env
文件,并指定以下内容:HOST=http://localhost:3000 SHOPIFY_API_KEY=<Your Shopify API key> SHOPIFY_API_SECRET=<Your Shopify API secret>
-
运行默认的 Shopify App 生成器:
rails generate shopify_app
-
运行数据库迁移:
rails db:migrate
-
启动应用:
rails server
-
在 Shopify Partners 中配置应用的 URL:
- App URL:
http://localhost:3000/
- Allowed redirection URL(s):
http://localhost:3000/auth/shopify/callback
- App URL:
-
访问应用的 URL(例如
http://localhost:3000
)并指定要安装应用的商店子域名。 -
安装完成后,你将被重定向到嵌入式应用。
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 托管安装和令牌交换来实现,消除了之前必要的重定向。
启用新策略
- 通过 Shopify CLI 配置范围,启用 Shopify 托管安装。
- 在应用的 ShopifyApp 配置文件中启用新授权策略:
ShopifyApp.configure do |config| config.embedded_app = true config.new_embedded_auth_strategy = true config.check_session_expiry_date = true end
- 处理特殊回调逻辑。
4. 项目安装方式
4.1 通过生成器安装
使用 rails generate shopify_app
命令可以快速生成一个嵌入式应用,并自动配置 OAuth 和会话令牌。
4.2 手动配置
你也可以手动配置应用,包括设置环境变量、配置路由和处理 OAuth 回调。
通过以上文档,你应该能够顺利安装和使用 Shopify App gem 来构建嵌入式应用。如果有任何问题,请参考 故障排除 或 升级指南。
登录后查看全文
热门项目推荐
- QQwen3-Next-80B-A3B-InstructQwen3-Next-80B-A3B-Instruct 是一款支持超长上下文(最高 256K tokens)、具备高效推理与卓越性能的指令微调大模型00
- QQwen3-Next-80B-A3B-ThinkingQwen3-Next-80B-A3B-Thinking 在复杂推理和强化学习任务中超越 30B–32B 同类模型,并在多项基准测试中优于 Gemini-2.5-Flash-Thinking00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0265cinatra
c++20实现的跨平台、header only、跨平台的高性能http库。C++00AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile06
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
1 freeCodeCamp音乐播放器项目中的函数调用问题解析2 freeCodeCamp论坛排行榜项目中的错误日志规范要求3 freeCodeCamp猫照片应用教程中的HTML注释测试问题分析4 freeCodeCamp全栈开发课程中React实验项目的分类修正5 freeCodeCamp课程视频测验中的Tab键导航问题解析6 freeCodeCamp全栈开发课程中React组件导出方式的衔接问题分析7 freeCodeCamp英语课程视频测验选项与提示不匹配问题分析8 freeCodeCamp课程页面空白问题的技术分析与解决方案9 freeCodeCamp博客页面工作坊中的断言方法优化建议10 freeCodeCamp 课程中关于角色与职责描述的语法优化建议
最新内容推荐
PCDViewer-4.9.0-Ubuntu20.04:专业点云可视化与编辑工具全面解析 JDK 8u381 Windows x64 安装包:企业级Java开发环境的完美选择 SAP S4HANA物料管理资源全面解析:从入门到精通的完整指南 VSdebugChkMatch.exe:专业PDB签名匹配工具全面解析与使用指南 基恩士LJ-X8000A开发版SDK样本程序全面指南 - 工业激光轮廓仪开发利器 ZLIB 1.3 静态库 Windows x64 版本:高效数据压缩解决方案完全指南 SteamVR 1.2.3 Unity插件:兼容Unity 2019及更低版本的VR开发终极解决方案 全球GEOJSON地理数据资源下载指南 - 高效获取地理空间数据的完整解决方案 LabVIEW串口通信开发全攻略:从入门到精通的完整解决方案 Windows版Redis 5.0.14下载资源:高效内存数据库的完美Windows解决方案
项目优选
收起

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K

deepin linux kernel
C
22
6

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0

React Native鸿蒙化仓库
C++
192
273

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392

openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K

Elasticsearch
国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8