跳到主要內容

入門指南

本指南將引導您完成在專案中啟動並執行 PaymentKit Node.js SDK 的基本步驟。只需幾分鐘,您就可以安裝 SDK,為測試環境進行設定,並進行您的第一次 API 呼叫。

1. 安裝

首先,使用 npm 將 PaymentKit SDK 加入您的專案。開啟您的終端機並執行以下指令:

Installation Command

bash
npm install @blocklet/payment-js

2. 設定

在進行任何 API 呼叫之前,您需要設定 SDK。至少,您必須匯入函式庫並設定環境。對於開發和測試,強烈建議使用測試環境,以避免處理真實交易。

建立一個新檔案,例如 index.js,並加入以下程式碼以在測試模式下初始化 SDK:

Initialize the SDK

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

// 使用測試環境以避免在開發過程中產生實際費用
payment.environments.setTestMode(true);

console.log('PaymentKit SDK 已設定為測試模式。');

有關管理不同環境的更多詳細資訊,請參閱 環境 文件。

3. 進行您的第一次 API 呼叫

現在 SDK 已經設定完成,您可以開始與 PaymentKit API 互動了。讓我們嘗試一個簡單的唯讀操作:列出所有訂閱。這是驗證您的設定是否正確的好方法。

將以下非同步函式加入您的 index.js 檔案並呼叫它:

List Subscriptions

javascript
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},狀態: ${sub.status}`);
      });
    } else {
      console.log('找不到訂閱。如果您尚未建立任何訂閱,這是正常的。');
    }

  } catch (error) {
    console.error('發生錯誤:', error.message);
  }
}

listSubscriptions();

從您的終端機執行該檔案:

bash
node index.js

您應該會看到您的測試訂閱列表,或一條訊息指出找不到任何訂閱。恭喜,您已成功整合 PaymentKit SDK!

後續步驟

您現在已經準備好探索 PaymentKit SDK 的核心功能。以下是一些建議您接下來學習的內容: