核心客户端
SDK的核心客户端类和OAuth认证服务。
异步客户端
kwaixiaodian.client.main.AsyncKwaixiaodianClient(app_key: str, app_secret: str, sign_secret: str, server_url: str = 'https://openapi.kwaixiaodian.com', sign_method: SignMethod = SignMethod.HMAC_SHA256, http_config: Optional[HTTPConfig] = None, retry_config: Optional[RetryConfig] = None, enable_logging: bool = False)
快手小店开放平台主客户端
对齐 Java 参考与 docs 的开放能力集合。
支持的业务域: - 订单管理 (order) - 订单查询、发货、状态更新 - 商品管理 (item) - 商品CRUD、库存、规格管理 - 售后管理 (refund) - 退款退货、协商处理 - 物流管理 (logistics) - 物流跟踪、发货管理 - 营销推广 (promotion) - 优惠券、活动管理 - 资金管理 (funds) - 账户资金、财务结算、提现管理 - 评论管理 (comment) - 评论查询、回复管理 - 店铺管理 (shop) - 店铺信息、装修配置 - 用户管理 (user) - 用户信息、粉丝管理 - 安全管理 (security) - 风控检测、安全认证 - 发票管理 (invoice) - 发票开具、发票查询 - 支付管理 (payment) - 支付配置、支付查询 - 直播管理 (live) - 直播间管理、直播数据 - 短信服务 (sms) - 短信发送、短信模板 - 分销管理 (distribution) - 分销商管理、分销政策 - 虚拟商品 (virtual) - 无 open.virtual.* 商家侧接口(请使用 industry 域) - 视频管理 (video) - 视频上传、视频审核
Features
- 🚀 异步支持 - 基于asyncio的高性能异步调用
- 🔐 安全认证 - 完整的OAuth和签名支持
- 📦 业务模型 - 类型安全的请求/响应模型
- ⚡ 自动重试 - 网络异常和token过期自动重试
- 🛡️ 错误处理 - 详细的异常信息和错误码映射
初始化快手SDK客户端
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
app_key
|
str
|
应用AppKey,从快手开放平台获取 |
必需 |
app_secret
|
str
|
应用AppSecret,从快手开放平台获取 |
必需 |
sign_secret
|
str
|
签名密钥SignSecret,从快手开放平台获取 |
必需 |
server_url
|
str
|
API服务器地址,默认为线上环境 |
'https://openapi.kwaixiaodian.com'
|
sign_method
|
SignMethod
|
签名算法,推荐使用HMAC_SHA256 |
HMAC_SHA256
|
http_config
|
Optional[HTTPConfig]
|
HTTP客户端配置,用于自定义超时、代理等 |
None
|
retry_config
|
Optional[RetryConfig]
|
重试策略配置 |
None
|
enable_logging
|
bool
|
是否启用调试日志 |
False
|
方法:
| 名称 | 描述 |
|---|---|
close |
关闭客户端,释放资源 |
scm |
SCM供应链管理服务 |
属性:
| 名称 | 类型 | 描述 |
|---|---|---|
order |
AsyncOrderService
|
订单服务 |
item |
AsyncItemService
|
商品服务 |
refund |
AsyncRefundService
|
售后服务 |
logistics |
AsyncLogisticsService
|
物流服务 |
funds |
AsyncFundsService
|
资金管理服务 |
industry |
AsyncIndustryService
|
行业特化服务 |
comment |
AsyncCommentService
|
评价管理服务 |
dropshipping |
AsyncDropshippingService
|
代发服务 |
shop |
AsyncShopService
|
店铺管理服务 |
user |
AsyncUserService
|
用户管理服务 |
security |
AsyncSecurityService
|
安全管理服务 |
invoice |
AsyncInvoiceService
|
发票管理服务 |
live |
AsyncLiveService
|
直播管理服务 |
photo |
AsyncPhotoService
|
照片管理服务(open.photo.*) |
sms |
AsyncSmsService
|
短信服务(open.sms.*) |
promotion |
AsyncPromotionService
|
营销推广服务(open.promotion.*) |
distribution |
AsyncDistributionService
|
分销管理服务 |
supply |
AsyncSupplyService
|
供应链服务 |
Attributes
order: AsyncOrderService
property
订单服务
提供订单查询、发货、备注更新等功能。
item: AsyncItemService
property
商品服务
提供商品创建、更新、查询、库存管理等功能。
refund: AsyncRefundService
property
售后服务
提供退款退货、协商处理、售后状态查询等功能。
logistics: AsyncLogisticsService
property
物流服务
提供物流跟踪、发货管理、配送查询等功能。
funds: AsyncFundsService
property
资金管理服务
提供账户资金查询、资金流水记录、提现管理、结算查询等功能。 支持完整的资金生命周期管理和财务对账功能。
industry: AsyncIndustryService
property
行业特化服务
提供垂直行业特化功能:虚拟商品订单详情查询、审核、解密和二手商品用户档案查询。
comment: AsyncCommentService
property
评价管理服务
提供完整的商品评价管理功能,包括评价查询与筛选、回复管理、评价审核、统计分析、有用性管理、模板管理、数据导出等。
dropshipping: AsyncDropshippingService
property
代发服务
提供完整的代发管理功能,包括电子面单管理、订单分配、发货管理、关系管理等。
shop: AsyncShopService
property
店铺管理服务
提供店铺信息、装修配置、经营数据等功能。
user: AsyncUserService
property
用户管理服务 提供用户信息、卖家信息、粉丝关系与子账号管理。
security: AsyncSecurityService
property
安全管理服务
提供风控检测、安全认证、权限管理等功能。
invoice: AsyncInvoiceService
property
发票管理服务
仅保留以下 Java 对齐端点: - open.invoice.subsidy.audit.info - open.invoice.amount.get
live: AsyncLiveService
property
直播管理服务
提供直播间管理、直播数据、直播商品等功能。
photo: AsyncPhotoService
property
照片管理服务(open.photo.*)
sms: AsyncSmsService
property
短信服务(open.sms.*)
promotion: AsyncPromotionService
property
营销推广服务(open.promotion.*)
distribution: AsyncDistributionService
property
分销管理服务
提供分销商管理、分销政策、佣金结算等功能。
supply: AsyncSupplyService
property
供应链服务
提供供应链同步功能:商品同步。
Functions
close() -> None
async
关闭客户端,释放资源
scm() -> AsyncScmService
SCM供应链管理服务
提供库存管理、商品管理、仓库管理等功能: - 库存调整、详情查询和更新 - 商品添加、查询、列表和更新 - 仓库添加、信息查询、列表查询和更新 - 包裹重量快递查询 - 销售范围模板管理
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ScmService |
AsyncScmService
|
SCM服务实例 |
同步客户端
kwaixiaodian.client.main.SyncKwaixiaodianClient(app_key: str, app_secret: str, sign_secret: str, server_url: str = 'https://openapi.kwaixiaodian.com', sign_method: SignMethod = SignMethod.HMAC_SHA256, http_config: Optional[HTTPConfig] = None, retry_config: Optional[RetryConfig] = None, enable_logging: bool = False)
快手小店开放平台同步客户端
提供对快手开放平台所有API的同步访问能力,支持25个业务域和896个API接口。
支持的业务域: - 订单管理 (order) - 订单查询、发货、状态更新 - 商品管理 (item) - 商品CRUD、库存、规格管理 - 售后管理 (refund) - 退款退货、协商处理 - 物流管理 (logistics) - 物流跟踪、发货管理 - 营销推广 (promotion) - 优惠券、活动管理 - 资金管理 (funds) - 账户资金、财务结算、提现管理 - 评论管理 (comment) - 评论查询、回复管理 - 店铺管理 (shop) - 店铺信息、装修配置 - 用户管理 (user) - 用户信息、粉丝管理 - 安全管理 (security) - 风控检测、安全认证 - 发票管理 (invoice) - 发票开具、发票查询 - 支付管理 (payment) - 支付配置、支付查询 - 直播管理 (live) - 直播间管理、直播数据 - 短信服务 (sms) - 短信发送、短信模板 - 分销管理 (distribution) - 分销商管理、分销政策 - 视频管理 (video) - 视频上传、视频审核
Features
- 🔄 同步调用 - 基于httpx的同步HTTP客户端
- 🔐 安全认证 - 完整的OAuth和签名支持
- 📦 业务模型 - 类型安全的请求/响应模型
- ⚡ 自动重试 - 网络异常和token过期自动重试
- 🛡️ 错误处理 - 详细的异常信息和错误码映射
初始化快手SDK同步客户端
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
app_key
|
str
|
应用AppKey,从快手开放平台获取 |
必需 |
app_secret
|
str
|
应用AppSecret,从快手开放平台获取 |
必需 |
sign_secret
|
str
|
签名密钥SignSecret,从快手开放平台获取 |
必需 |
server_url
|
str
|
API服务器地址,默认为线上环境 |
'https://openapi.kwaixiaodian.com'
|
sign_method
|
SignMethod
|
签名算法,推荐使用HMAC_SHA256 |
HMAC_SHA256
|
http_config
|
Optional[HTTPConfig]
|
HTTP客户端配置,用于自定义超时、代理等 |
None
|
retry_config
|
Optional[RetryConfig]
|
重试策略配置 |
None
|
enable_logging
|
bool
|
是否启用调试日志 |
False
|
方法:
| 名称 | 描述 |
|---|---|
close |
关闭客户端,释放资源 |
scm |
SCM供应链管理服务 |
属性:
| 名称 | 类型 | 描述 |
|---|---|---|
order |
SyncOrderService
|
订单服务 |
item |
SyncItemService
|
商品服务 |
refund |
SyncRefundService
|
售后服务 |
logistics |
SyncLogisticsService
|
物流服务 |
funds |
SyncFundsService
|
资金管理服务 |
industry |
SyncIndustryService
|
行业特化服务 (同步) |
comment |
SyncCommentService
|
评价管理服务 |
dropshipping |
SyncDropshippingService
|
代发服务 (同步) |
shop |
SyncShopService
|
店铺管理服务 |
user |
SyncUserService
|
用户管理服务 |
security |
SyncSecurityService
|
安全管理服务 |
invoice |
SyncInvoiceService
|
发票管理服务 |
live |
SyncLiveService
|
直播管理服务 |
distribution |
SyncDistributionService
|
分销管理服务 |
supply |
SyncSupplyService
|
供应链服务 (同步) |
Attributes
order: SyncOrderService
property
订单服务
提供订单查询、发货、备注更新等功能。
item: SyncItemService
property
商品服务
提供商品创建、更新、查询、库存管理等功能。
refund: SyncRefundService
property
售后服务
提供退款退货、协商处理、售后状态查询等功能。
logistics: SyncLogisticsService
property
物流服务
提供物流跟踪、发货管理、配送查询等功能。
funds: SyncFundsService
property
资金管理服务
提供账户资金查询、资金流水记录、提现管理、结算查询等功能。 支持完整的资金生命周期管理和财务对账功能。
industry: SyncIndustryService
property
行业特化服务 (同步)
提供垂直行业特化功能的同步版本。
comment: SyncCommentService
property
评价管理服务
提供完整的商品评价管理功能,包括评价查询与筛选、回复管理、评价审核、统计分析、有用性管理、模板管理、数据导出等。
dropshipping: SyncDropshippingService
property
代发服务 (同步)
提供完整的代发管理功能,包括电子面单管理、订单分配、发货管理、关系管理等。
shop: SyncShopService
property
店铺管理服务
提供店铺信息、装修配置、经营数据等功能。
user: SyncUserService
property
用户管理服务 提供用户信息、卖家信息、粉丝关系与子账号管理。
security: SyncSecurityService
property
安全管理服务
提供风控检测、安全认证、权限管理等功能。
invoice: SyncInvoiceService
property
发票管理服务
仅保留以下 Java 对齐端点: - open.invoice.subsidy.audit.info - open.invoice.amount.get
live: SyncLiveService
property
直播管理服务
提供直播间管理、直播数据、直播商品等功能。
distribution: SyncDistributionService
property
分销管理服务
提供分销商管理、分销政策、佣金结算等功能。
supply: SyncSupplyService
property
供应链服务 (同步)
提供供应链同步功能的同步版本。
Functions
close() -> None
关闭客户端,释放资源
scm() -> SyncScmService
SCM供应链管理服务
提供库存管理、商品管理、仓库管理等功能: - 库存调整、详情查询和更新 - 商品添加、查询、列表和更新 - 仓库添加、信息查询、列表查询和更新 - 包裹重量快递查询 - 销售范围模板管理
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
SyncScmService |
SyncScmService
|
SCM服务实例 |
OAuth认证客户端
异步OAuth客户端
kwaixiaodian.client.oauth.AsyncOAuthClient(app_key: str, app_secret: str, server_url: str = 'https://openapi.kwaixiaodian.com', http_config: Optional[HTTPConfig] = None)
OAuth认证客户端
专门处理OAuth认证流程的客户端类。
初始化OAuth客户端
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
app_key
|
str
|
应用Key |
必需 |
app_secret
|
str
|
应用Secret |
必需 |
server_url
|
str
|
服务器地址 |
'https://openapi.kwaixiaodian.com'
|
http_config
|
Optional[HTTPConfig]
|
HTTP配置 |
None
|
方法:
| 名称 | 描述 |
|---|---|
close |
关闭客户端 |
close() -> None
async
关闭客户端
同步OAuth客户端
kwaixiaodian.client.oauth.SyncOAuthClient(app_key: str, app_secret: str, server_url: str = 'https://openapi.kwaixiaodian.com', http_config: Optional[HTTPConfig] = None)
同步OAuth认证客户端
专门处理OAuth认证流程的同步客户端类。
初始化同步OAuth客户端
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
app_key
|
str
|
应用Key |
必需 |
app_secret
|
str
|
应用Secret |
必需 |
server_url
|
str
|
服务器地址 |
'https://openapi.kwaixiaodian.com'
|
http_config
|
Optional[HTTPConfig]
|
HTTP配置 |
None
|
方法:
| 名称 | 描述 |
|---|---|
close |
关闭客户端 |
close() -> None
关闭客户端