Shopify Python API 使用教程

1. 项目介绍

Shopify Python API 是一个开源库，允许 Python 开发者通过编程方式访问 Shopify 商店的管理部分。该库基于 pyactiveresource 构建，提供了与 Ruby Shopify API gem 类似的接口。通过该库，开发者可以轻松地与 Shopify 的 RESTful API 进行交互，执行创建、读取、更新和删除（CRUD）操作。

2. 项目快速启动

安装

首先，使用 pip 安装 ShopifyAPI 库：

pip install --upgrade ShopifyAPI

配置

在使用 API 之前，需要配置 API 密钥和商店 URL。以下是配置步骤：

公共应用

1. 在 Shopify 合作伙伴仪表板中创建一个新的应用，并获取 API_KEY 和 API_SECRET。
2. 设置会话并生成授权 URL：

import shopify

# 设置 API 密钥和密钥
shopify.Session.setup(api_key=API_KEY, secret=API_SECRET)

# 定义商店 URL 和 API 版本
shop_url = "SHOP_NAME.myshopify.com"
api_version = '2024-07'

# 创建会话并生成授权 URL
state = binascii.b2a_hex(os.urandom(15)).decode("utf-8")
redirect_uri = "http://myapp.com/auth/shopify/callback"
scopes = ['read_products', 'read_orders']

newSession = shopify.Session(shop_url, api_version)
auth_url = newSession.create_permission_url(scopes, redirect_uri, state)

# 重定向到 auth_url

3. 在回调处理程序中交换代码以获取访问令牌：

session = shopify.Session(shop_url, api_version)
access_token = session.request_token(request_params)

# 保存访问令牌以供将来使用

私有应用

对于私有应用，可以直接使用私有应用密码作为访问令牌：

session = shopify.Session(shop_url, api_version, private_app_password)
shopify.ShopifyResource.activate_session(session)

使用 API

激活会话后，可以开始使用 API 进行操作：

# 获取当前商店
shop = shopify.Shop.current()

# 获取特定产品
product = shopify.Product.find(179761209)

# 创建新产品
new_product = shopify.Product()
new_product.title = "Burton Custom Freestyle 151"
new_product.product_type = "Snowboard"
new_product.vendor = "Burton"
success = new_product.save()

# 更新产品
product.handle = "burton-snowboard"
product.save()

3. 应用案例和最佳实践

应用案例

• 库存管理：通过 API 自动更新库存数量，确保库存数据的实时性。
• 订单处理：自动处理订单，生成发货单并更新订单状态。
• 产品导入：从外部系统导入产品数据到 Shopify 商店。

最佳实践

• 错误处理：在执行 API 请求时，始终检查返回值和错误信息，确保操作的可靠性。
• 分页处理：对于大量数据的查询，使用分页功能避免一次性加载过多数据。
• 安全认证：确保使用安全的认证方式，避免敏感信息泄露。

4. 典型生态项目

• Shopify CLI：Shopify 提供的命令行工具，用于管理 Shopify 商店和应用。
• Shopify Polaris：Shopify 的 UI 组件库，用于构建 Shopify 应用的用户界面。
• Shopify App Bridge：用于在 Shopify 应用中嵌入 Shopify 管理界面的工具。

通过这些生态项目，开发者可以更高效地构建和扩展 Shopify 应用。