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.0.0

快速使用

以下示例程序演示了如何Clint初始化，获取Url应用最新升级信息。

获取Url应用最新升级信息

import Client, { UrlUpgradeRequest } from '@toolsetlink/upgradelink-api-typescript';

// 测试获取URL升级信息
async function testGetUrlUpgrade() {
    try {
        // 初始化客户端
        const client = new Client('mui2W50H1j-OC4xD6PgQag', 'PEbdHFGC0uO_Pch7XWBQTMsFRxKPQAM2565eP8LJ3gc');

        // 构造请求参数
        const request = new UrlUpgradeRequest({
            urlKey: 'OpggWISrLVRFa5y04LzkwA',
            versionCode: 1,
            appointVersionCode: 0,
            devModelKey: 'MODEL',
            devKey: 'FINGERPRINT'
        });

        // 发起请求
        const response = await client.getUrlUpgrade(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('\n获取URL升级信息失败:', error);
    }
}