メインコンテンツへスキップ

はじめに

このガイドでは、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の主要な機能を探る準備が整いました。次に学習する内容として、以下の項目をお勧めします。