SDK 结构
PaymentKit Node.js SDK 由一系列模块组成，每个模块对应一个特定的 API 资源，例如 products、customers 或 subscriptions。这种模块化的设计提供了一种清晰且可预测的方式，用于与 PaymentKit API 的不同部分进行交互。初始化客户端后，你可以通过主 payment 对象上的属性来访问每个资源。
在深入了解其结构之前，请确保你已完成 快速入门 指南中所述的设置。
客户端初始化与资源访问#
首先，导入并初始化客户端。默认导出的对象是访问所有 API 资源的入口点。
import payment from '@blocklet/payment-js';
// 访问 'products' 资源以列出产品
async function getProducts() {
const productList = await payment.products.list({ pageSize: 5 });
console.log('Fetched products:', productList.data);
}
// 访问嵌套的 'checkout.sessions' 资源以创建会话
async function createCheckoutSession() {
// 假设你已定义 line_items
const session = await payment.checkout.sessions.create({
// ... 会话参数
});
console.log('Created session:', session.id);
}该结构遵循一个一致的模式：payment.<resource_name>.<method_name>()。
API 资源模块#
SDK 的结构可视化如下，展示了如何从主客户端对象访问不同的资源。
每个模块都提供了与其对应的 API 资源进行交互的方法（例如 create、retrieve、update、list）。可用的主要资源有：
模块 | 描述 |
|---|---|
| 创建和管理会话，用于处理支付和设置订阅。 |
| 管理客户记录。 |
| 为客户发放和管理信用额度。 |
| 列出并汇总客户的信用交易历史。 |
| 创建和管理计量器以跟踪使用情况。 |
| 向计量器报告使用情况事件。 |
| 列出支持的支付货币。 |
| 处理支付的生命周期，从创建到确认。 |
| 创建和管理可共享的支付链接。 |
| 管理支付方式配置。 |
| 管理产品的定价模型。 |
| 管理你提供的产品或服务。 |
| 处理支付退款。 |
| 管理应用级设置。 |
| 管理客户的产品订阅。 |
| 管理订阅中的单个项目。 |
| 配置端点以接收事件通知。 |
工具模块#
除了 API 资源，SDK 还包含一些工具模块。
environments
environments 模块用于配置 SDK，主要用于在测试模式和生产模式之间切换。你可以在 环境 指南中了解更多信息。
TypeScript 类型#
SDK 还从 @blocklet/payment-types 包中重新导出了所有类型定义。如果你正在使用 TypeScript，这可以在你的开发环境中启用强类型和自动补全功能。有关更多详细信息，请参阅 TypeScript 支持 部分。
现在你已经了解了 SDK 的组织方式，下一步是学习如何配置你的 API 密钥和环境。请继续阅读 环境 指南。