Selling Partner API Models 核心组件揭秘:目录结构与文件功能详解
Selling Partner API Models 是亚马逊卖家开发软件时调用 Selling Partner APIs 的关键资源库,包含丰富的 OpenAPI 模型,为开发者提供标准化的接口定义和数据结构。本文将深入剖析其核心组件,助你快速掌握项目架构与文件功能。
一、项目整体架构概览
项目采用模块化设计,主要分为四大核心目录:clients/、models/、schemas/ 及根目录文档。这种结构清晰分离了不同功能模块,便于开发者按需查找和使用资源。
1.1 核心目录功能速览
clients/:存放各编程语言的认证授权客户端实现,如 Java、Python、C# 等版本models/:包含各 API 服务的 OpenAPI 模型定义文件,按服务类型分类schemas/:提供报告、通知、数据 kiosk 等功能的 JSON/GraphQL 模式定义- 根目录:包含项目说明文档(
README.md)、贡献指南(CONTRIBUTING.md)等基础信息
二、关键目录深度解析
2.1 认证授权客户端:clients/
该目录提供多种编程语言的认证授权解决方案,支持 LWA(Login with Amazon)流程和受限数据令牌(RDT)管理。主要子项目包括:
sellingpartner-api-aa-java/:Java 版本的认证授权库,实现了LWAClient、LWAAuthorizationSigner等核心类,支持令牌缓存和签名生成sellingpartner-api-aa-python/:Python SDK,包含auth/目录下的认证异常处理(LwaException.py)和请求类(LwaRequest.py)sellingpartner-api-aa-csharp/:C# 实现,提供Amazon.SellingPartnerAPIAA命名空间下的完整认证组件
2.2 API 模型定义:models/
按 API 服务类型组织的 OpenAPI 模型文件,命名格式通常为 {服务名称}_{版本号}.json。例如:
- 订单管理:
orders_2026-01-01.json定义最新版订单 API 的请求/响应结构 - 库存管理:
fbaInventory.json包含 FBA 库存相关接口定义 - 产品定价:
productPricing_2022-05-01.json提供产品定价 API 的数据模型
2.3 数据模式定义:schemas/
包含各类业务数据的结构定义,支持报告生成、通知处理等场景:
- 报告模式:
reports/accountHealthReport-2020-11-18.json定义账户健康报告的数据格式 - 通知模式:
notifications/OrderChangeNotification.json规范订单变更通知的消息结构 - 数据 kiosk:
data-kiosk/analytics_salesAndTraffic_2024_04_24.graphql提供销售流量分析的 GraphQL 模式
三、核心文件功能详解
3.1 认证授权核心文件
LWAClient.java(clients/sellingpartner-api-aa-java/src/com/amazon/SellingPartnerAPIAA/):LWA 客户端主类,处理令牌请求与刷新RestrictedDataTokenSigner.php(clients/sellingpartner-api-aa-php/src/authandauth/):生成受限数据令牌的签名工具
3.2 API 模型关键文件
tokens_2021-03-01.json(models/tokens-api-model/):令牌 API 的 OpenAPI 定义,包含 RDT 相关接口feeds_2021-06-30.json(models/feeds-api-model/): feeds API 模型,支持产品数据上传功能
3.3 辅助工具与示例
sample_node_app/index.mjs(clients/sellingpartner-api-aa-javascript/src/sample_node_app/):JavaScript 认证示例RestrictedDataTokenWorkflow.java(clients/sample-code/):RDT 工作流示例代码
四、快速上手与资源获取
要开始使用 Selling Partner API Models,可通过以下步骤获取项目:
git clone https://gitcode.com/gh_mirrors/se/selling-partner-api-models
项目根目录的 README.md 提供基础介绍,各客户端目录下的 README.md(如 clients/sellingpartner-api-aa-python/README.md)包含语言特定的使用指南。
五、总结
Selling Partner API Models 通过清晰的目录结构和标准化的文件定义,为开发者提供了调用亚马逊 Selling Partner APIs 的完整资源。掌握 clients/ 的认证组件、models/ 的 API 定义和 schemas/ 的数据结构,将帮助你高效构建合规的亚马逊卖家应用。
无论是新手开发者还是有经验的团队,都能从这个项目中获取所需的接口规范和认证工具,加速亚马逊生态系统的集成开发。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考



