快速入门
本指南提供了安装 PaymentKit Node.js SDK、配置环境以及进行首次 API 调用的基本步骤。遵循这些说明可以帮助你快速上手。
安装#
PaymentKit SDK 以 npm 包的形式提供。你可以使用 npm 或其他包管理器在你的 Node.js 项目中安装它。
npm install @blocklet/payment-js配置#
安装后，你需要在应用程序中导入并配置该 SDK。主要配置步骤包括将环境设置为测试模式或生产模式。
1. 导入 SDK#
首先，将 SDK 中的 payment 对象导入到你的应用程序文件中。
import payment from '@blocklet/payment-js';2. 设置环境#
PaymentKit 有两种运行模式。在进行任何 API 调用之前，你必须通过代码设置环境。
- 测试模式：用于开发和测试。交易是模拟的，不涉及真实资金。
- 生产模式：用于生产环境，处理真实交易。
// 使用测试环境（推荐用于开发）
payment.environments.setTestMode(true);
// 使用生产环境（用于生产）
// payment.environments.setLiveMode(true);进行首次 API 调用#
配置好 SDK 后，你就可以与 PaymentKit API 进行交互了。以下示例演示了如何在测试环境中列出现有订阅。
import payment from '@blocklet/payment-js';
// 将环境设置为测试模式
payment.environments.setTestMode(true);
async function getSubscriptions() {
try {
console.log('正在获取前 5 个订阅...');
const subscriptions = await payment.subscriptions.list({
pageSize: 5, // 限制为 5 个结果
order: 'updated_at:DESC' // 首先获取最近更新的
});
console.log('API 响应:', subscriptions);
} catch (error) {
console.error('发生错误:', error.message);
}
}
getSubscriptions();响应示例
运行此代码可以确认你的 SDK 已正确设置并能与 API 通信。对于新账户，你可能会收到一个空列表。
{
"page": 1,
"pageSize": 5,
"total": 0,
"data": []
}下一步#
你已成功安装并配置 PaymentKit SDK。要深入了解其功能，我们建议你浏览以下部分：