Быстрый старт с 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

Пример успешного возврата показан ниже, что указывает на то, что вы успешно установили SDK:

 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 upgrade information response:');
        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('\nFailed to get URL upgrade information:', error);
    }
}