购物者SDK
🎉 用于 Shopee 打开 API 的最完整、 生产准备的 TypeScript SDK 🎉
用我们全能的SDK 来建立强大的Shopee集成系统 百分之百的 Shopee API 端点. 由开发者信任,社区建设.
页:1
- 完整文档 - 综合指南和API参考资料
- 移徙指南v2.0 - 从v1.x升级到v2.0的指南
- AI 登入和LLM指南 - 专为AI Agency和LLMs编写的登机指南高文本,以快速理解代码库架构并开始编码.
快速链接
开始 :
- 设置指南 - 安装和配置
- 认证 - OAuth流量和标识管理
- 用户认证 - 视频和Livestream授权、签名和整合测试
- 托肯存储 - 管理出入证
- 代理配置 - 使用HTTP/HTTPS代理
- 请求 - 超时、重试、出错、钩子、相接和上传
API 管理员 :
- 认证管理器 - 认证业务
- 产品管理器 - 产品目录管理
- 命令管理器 - 处理订单
- 后勤 经理 - 航运业务
- 付款管理人 - 付款信息
- 售金管理员 - 贴现管理
- 推进管理器 - 网页和通知
- 公共管理者 - 公共API终点
- 广告管理员 - 广告宣传
- 管理员 - 附属营销解决方案
- 会计健康经理 - 业绩计量
- 商店经理 - 商店信息和设置
- 媒体管理器 - 图像和视频上传
- 媒体空间管理器 - 媒体上传(图像和视频)
- 商业经理 - 商业信息和仓库
- 全球生产经理 - 全球产品管理
- 第一邮件管理员 - 第一英里后勤
- 贴现经理 - 贴现活动
- 软件包管理器 - 包厢交易升级
- 添加Deal 管理器 - 附加交易升级
- 商店快卖经理 - 闪光销售活动
- 跟随 Prize 管理器 - 开展奖励活动
- 顶级 Picks 管理器 - 顶级选集
- 商店类别管理器 - 商店类别管理
- 回归管理器 - 返还和退款管理
- Sbs 管理器 - 商店业务服务仓库库存
- Fbs 管理器 - 由Shopee业务完成
- 活流管理器 - 实时流线功能
- 视频管理器 - 录像专辑和分析
安装
npm install @congminh1254/shopee-sdk
所需经费: 节点.js >= 20.0.0
你得到的东西
所有30个API管理器的完整类型脚本定义
自动令牌刷新和管理
QQ 内置错误处理和重试逻辑
零依赖关系(节点牵引除外)
* 完整的文档和实例
快速启动
起来,马上跑! 与Shopee融合是多么容易:
import { ShopeeSDK, ShopeeRegion } from "@congminh1254/shopee-sdk";
// 1. Initialize the SDK with your credentials
const sdk = new ShopeeSDK({
partner_id: 123456,
partner_key: "your-partner-key",
region: ShopeeRegion.GLOBAL,
shop_id: 789012, // Optional for shop-specific operations
});
// 2. Authenticate your shop (OAuth flow)
const authUrl = sdk.getAuthorizationUrl("https://your-app.com/callback");
console.log("Visit:", authUrl);
// After user authorizes, exchange code for token (automatic token storage!)
await sdk.authenticateWithCode("auth-code-from-callback");
// 3. Start using the API - it's that simple!
// Manage your products
const products = await sdk.product.getItemList({
offset: 0,
page_size: 20,
});
// Process orders
const orders = await sdk.order.getOrderList({
time_range_field: "create_time",
time_from: Math.floor(Date.now() / 1000) - 86400,
time_to: Math.floor(Date.now() / 1000),
page_size: 50,
});
// Track shipments
const shipping = await sdk.logistics.getShippingParameter({
order_sn: "220615ABCDEF",
});
// Handle returns
const returns = await sdk.returns.getReturnList({
page_size: 20,
});
// And much more - all with full TypeScript support! 🎉
就这样! SDK处理令牌刷新,请求签名,出错处理,以及更多的自动处理.
为什么选这个SDK?
生产准备和战斗测试
- 100%的核心测试覆盖率 采用700+强活单元和活沙盒集成测试----确保最终生产可靠性
- 零妥协 - 落实和记录每个Shopee API终点
- 类型安全 - 完整类型脚本定义在错误发生前加以防止
- 积极维护 - 定期更新,以便与Shopee API 更改同步
* API全覆盖 -- -- 所有30名管理人员已执行
与其他部分覆盖的SDK不同,我们提供 完全访问 给每个 Shopee API :
核心商业:
- 📦 产品管理器 - 有55个以上终点的产品目录管理
- 🛒 命令管理器 - 完成订单处理和实现工作流程
- 🚚 后勤 经理 - 全面运输和跟踪业务
- 💳 付款管理人 - 付款和代管信息管理
营销和促销:
- 🎟️ 售金管理员 - 贴现券活动
- 💥 贴现经理 - 折扣促销活动
- 🎁 软件包管理器 - 包厢交易升级
- ➕ 添加Deal 管理器 - 附加交易升级
- ⚡ 商店快卖经理 - 闪光销售活动
- 🎯 跟随 Prize 管理器 - 开展奖励活动
- ⭐ 顶级 Picks 管理器 - 顶级产品收藏
- 📣 管理员 - 关联营销解决方案(AMS)
存储管理 :
- 🏪 商店经理 - 商店信息和简介管理
- 🏢 商业经理 - 商贸信息、仓库和多商店管理
- 📂 商店类别管理器 - 商店类组织
- 🖼️ 媒体管理器 打开 媒体空间管理器 - 图像和视频上传操作
高级特性 :
- 🔐 认证管理器 - OAuth流量和象征性生命周期管理
- 📢 推进管理器 - 网页和实时通知
- 🌍 全球生产经理 - 跨界产品管理
- 🔄 回归管理器 - 返回和退款申请处理
- 📊 广告管理员 - 广告运动管理
- 📈 会计健康经理 - 业绩计量和分析
- 🌐 公共管理者 - 公共API终点(不需要认证)
- 📍 第一邮件管理员 - 第一英里后勤业务
- 🏭 Sbs 管理器 - 商店业务处仓库库存
- 📦 Fbs 管理器 - 由Shopee业务完成
- 📹 活流管理器 - 实时流线功能
- 🎬 视频管理器 - 录像专辑和分析
QQ 开发者经验第一
- 直观 API 设计 - 在所有管理人员之间保持清晰、一致的界面
- 自动刷新令牌 - 内置代币管理, 不用担心过期
- 弹性存储 - 包含基于文件的存储,易于执行自定义解决方案
- 多区域支助 - 在所有12个Shopeee地区无缝工作
- 代理支持 - 企业准备的HTTP/HTTPS代理配置
- 综合文件 - 每一功能的详细指南和现实世界实例
- 全类型安全 - 自动完整和防出错的完整脚本定义
实际世界使用案例
这个SDK很适合建造:
- 🏪 多渠道电子商务平台 - 通过多个销售渠道同步库存、订单和产品
- 📊 分析板 - 追踪销售业绩、客户行为和商业衡量标准
- 🤖 自动化工具 - 自动处理订单、更新库存和客户通信
- 🔄 ERP 整合 - 将Shopee与你现有的业务系统连接起来
- 📱 移动应用程序 - 为商店管理积累本土移动经验
- 🎯 营销自动化 - 方案管理促销、券和广告活动
- 📦 库存管理系统 - 仓库之间的实时库存追踪
- 🚀 自定义存储前端 - 利用Shopee的基础设施创造独特的购物经验
从其他SDK家搬来?
切换很简单! 我们的SDK提议:
- 更完整的覆盖率 - 每一个终点都得到了执行,而不仅仅是基本
- 更好的类型脚本支持 - 从头到尾的全面安全
- 较简单的 API - 直观、组织良好的经理班
- 主动维修 - 定期更新和社区支助
- 生产准备 - 全面试验试验
检查我们 移徙指南 要开始.
测试和质量保证
这种SDK是作为一等公民以可靠和正确的方式建造的,在模拟单元环境和活出外部沙盒系统两方面都具有广泛的测试覆盖面.
1. 单位测试
- 模拟管理器覆盖结束 1 160+单元测试 验证所有30个API管理器的标准参数,响应布局,请求符号生成和出错边界.
- 100%代码覆盖率: 所有核心和管理逻辑文件都保持严格 100%的语句、分支和行码覆盖。 。 。 .
- 运行单元测试 :
npm run test
2.活沙盒综合试验
我们的集成测试套件执行真正的 HTTP 请求 shopee Sandbox 环境 (使用动态 OAuth 证书) 验证端到端集成安全 :
- 通行证:测试完整的 CRUD 生命周期(创建、取取出、更新限制,以及自动清理/删除测试凭证).
- 媒体和视频: 验证安全透明的PNG上传,视频会话初始化,以及使用内置,高度优化的10秒Base64 MP4 H.264视频固定的完整块视频上传工作流程.
- 后勤和文件:验证热运标签文档生成和下载工作.
- 付款设置( S):检查公共支付方法,商店分期配置,活性订单,本地产品,以及动态Shopee服务器IP范围.
- 运行沙盒集成测试 :
npm run test:sandbox
捐款
我们用 常规武器委员会 用于将信件自动编辑和发布注释.
承诺信息的例子:
feat: add support for logistics API- 小版本起伏fix: correct error handling in order API- 补丁版本凸起docs: update API documentation- 没有版本突起feat!: rename parameters in product API或者说feat: rename parameters in product API BREAKING CHANGE: ...- 主要版本起伏
释放进程
这个项目使用 释放请 实现版本管理和发布自动化.
释放过程遵循这些步骤:
- 对主分支的提交会自动分析
- 当检测到常规承诺消息时, 请释放
- 当发布 PR 合并时 :
- 创建新的 GitHub 标签并发布
- 软件包自动发布到 npm
- ChangeGELOG.md 随发行说明更新
许可证
麻省理工学院