@qzsy/wph-sdk
v0.1.0
Published
唯品会开放平台 VOP TypeScript SDK
Keywords
Readme
@qzsy/wph-sdk
唯品会开放平台 VOP 的零运行时依赖 TypeScript SDK,支持 Bun 和 Node.js。SDK 收录文档站 8 个分类、130 个服务和 633 个 API 方法,并为在线文档可达的请求、响应、嵌套结构和枚举生成类型。
import { VopClient } from "@qzsy/wph-sdk";
const vop = new VopClient({
appKey: process.env.VOP_APP_KEY!,
appSecret: process.env.VOP_APP_SECRET!,
accessToken: process.env.VOP_ACCESS_TOKEN,
});
const addressApi = vop.service("vipapis.address.AddressService");
const address = await addressApi.getFullAddress({ area_code: "0" });VopClientOptions.environment 支持 production 和 sandbox,默认正式环境。也可以传入 baseUrl 指定兼容入口。正式入口为 https://vop.vipapis.com,沙箱入口为 http://sandbox.vipapis.com。
SDK 根据 VOP API 开发规范把系统参数放入 Query String,把业务参数 JSON 放入 POST 请求体,并用 HMAC-MD5 生成大写签名。需要 OAuth 的方法会在未配置 accessToken 时于本地报错。接口级参数名保留文档原始拼写,例如 area_code。
完整方法页 URL 索引见 docs/API_URL_INDEX.md。包仅从 dist 导出;仓库根目录运行 bun run build 后即可在 workspace 中导入。
