快速入门


本指南将引导您完成在项目中启动和运行 PaymentKit Node.js SDK 的基本步骤。只需几分钟,您就可以安装 SDK,为测试环境进行配置,并进行您的第一次 API 调用。

1. 安装#

首先,使用 npm 将 PaymentKit SDK 添加到您的项目中。打开您的终端并运行以下命令:

Installation Command

npm install @blocklet/payment-js

2. 配置#

在进行任何 API 调用之前,您需要配置 SDK。至少,您必须导入库并设置环境。对于开发和测试,强烈建议使用测试环境,以避免处理真实的交易。

创建一个新文件,例如 index.js,并添加以下代码以在测试模式下初始化 SDK:

Initialize the SDK

import payment from '@blocklet/payment-js';

// 使用测试环境以避免在开发过程中产生真实费用
payment.environments.setTestMode(true);

console.log('PaymentKit SDK 已配置为测试模式。');

有关管理不同环境的更多详细信息,请参阅 环境 文档。

3. 进行您的第一次 API 调用#

现在 SDK 已配置完毕,您可以与 PaymentKit API 进行交互了。让我们尝试一个简单的只读操作:列出所有订阅。这是验证您的配置是否正确的好方法。

将以下异步函数添加到您的 index.js 文件中并调用它:

List Subscriptions

import payment from '@blocklet/payment-js';

// 使用测试环境
payment.environments.setTestMode(true);

async function listSubscriptions() {
  try {
    console.log('正在获取订阅...');
    const subscriptions = await payment.subscriptions.list({
      order: 'updated_at:ASC', // 按更新时间排序
      pageSize: 5,           // 限制为 5 个结果
    });

    if (subscriptions.data.length > 0) {
      console.log(`成功检索到 ${subscriptions.data.length} 个订阅:`);
      subscriptions.data.forEach(sub => {
        console.log(`- ID: ${sub.id}, Status: ${sub.status}`);
      });
    } else {
      console.log('未找到订阅。如果您尚未创建任何订阅,这是正常现象。');
    }

  } catch (error) {
    console.error('发生错误:', error.message);
  }

See all 3 lines

在您的终端中运行该文件:

node index.js

您应该会看到您的测试订阅列表或一条指示未找到任何订阅的消息。恭喜,您已成功集成 PaymentKit SDK!

后续步骤#

您现在已准备好探索 PaymentKit SDK 的核心功能。以下是一些关于接下来学习内容的建议: