TypeScript SDK クイックスタート

このドキュメントでは、TypeScript SDK を使用して一般的な操作を実行するためのクイックスタートガイドを提供します。 SDK のインストール方法、アクセス認証情報の設定方法、最新のアップグレード情報の取得などの基本操作を学びます。

注意事項

• TypeScript SDK を使用してリクエストを送信するには、Client インスタンスを初期化する必要があります。この記事では、デフォルト設定を読み込むことで Client を作成します。クライアントの詳細な設定オプションについては、「クライアントの設定」を参照してください。

前提条件

• UpgradeLink アカウントを登録していること。
• AccessKey と AccessSecret を取得していること。
• URL アプリケーションのアップグレード戦略を設定していること。

認証情報の取得

SDK のインストール

次のコマンドを実行して SDK をインストールします：

npm install @toolsetlink/upgradelink-api-typescript

SDK の確認

次のコマンドを使用してインストールを確認し、バージョンを確認できます：

 npm view @toolsetlink/upgradelink-api-typescript versions

正常な戻りの例を次に示します。これは、インストールが成功したことを示しています：

 1.5.0

クイック使用法

次のサンプルプログラムは、Client を初期化して URL アプリケーションの最新のアップグレード情報を取得する方法を示しています。

URL アプリケーションの最新アップグレード情報を取得する

const {
    default: Client,
    Config,
    UrlUpgradeRequest,
} = require('@toolsetlink/upgradelink-api-typescript');


// URL アップグレード情報の取得テスト
async function testGetUrlUpgrade() {
    try {
         // クライアントを初期化
        const config = new Config({
            accessKey:  'mui2W50H1j-OC4xD6PgQag',
            accessSecret: 'PEbdHFGC0uO_Pch7XWBQTMsFRxKPQAM2565eP8LJ3gc',
        });
        const client = new Client(config);

        // リクエストパラメータを構築
        const request = new UrlUpgradeRequest({
            urlKey: 'uJ47NPeT7qjLa1gL3sVHqw',
            versionCode: 1,
            appointVersionCode: 0,
            devModelKey: '',
            devKey: ''
        });

        // リクエストを送信
        const response = await client.UrlUpgrade(request);

        // レスポンス結果を出力
        console.log('\nURL アップグレード情報レスポンス:');
        console.log(`code: ${response.code}`);
        console.log(`msg: ${response.msg}`);
        console.log('data:');
        console.log(`  urlKey: ${response.data.urlKey}`);
        console.log(`  versionName: ${response.data.versionName}`);
        console.log(`  versionCode: ${response.data.versionCode}`);
        console.log(`  urlPath: ${response.data.urlPath}`);
        console.log(`  upgradeType: ${response.data.upgradeType}`);
        console.log(`  promptUpgradeContent: ${response.data.promptUpgradeContent}`);
    } catch (error) {
        console.error('\nURL アップグレード情報の取得に失敗しました:', error);
    }
}