راه‌اندازی سریع TypeScript SDK

این سند راهنمای راه‌اندازی سریع برای استفاده از TypeScript SDK برای عملیات‌های معمول ارائه می‌دهد. شما یاد می‌گیرید که چگونه SDK را نصب کنید، اعتبارهای دسترسی را پیکربندی کنید، و عملیات‌های پایه‌ای مانند دریافت آخرین اطلاعات به‌روزرسانی را انجام دهید.

نکات

• برای ارسال درخواست‌ها با استفاده از TypeScript SDK، نیاز به راه‌اندازی یک نمونه Client دارید. این مقاله Client را با بارگذاری پیکربندی‌های پیش‌فرض ایجاد می‌کند. برای گزینه‌های پیکربندی بیشتر برای کلاینت، به Configure 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 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);
    }
}