Inicio Rápido del SDK de TypeScript

Este documento proporciona un guía de inicio rápido para usar el SDK de TypeScript para operaciones comunes. Aprenderás cómo instalar el SDK, configurar las credenciales de acceso y realizar operaciones básicas como recuperar la información de actualización más reciente.

Notas

• Para hacer solicitudes usando el SDK de TypeScript, necesitas inicializar una instancia de Client. Este artículo crea un Client cargando configuraciones predeterminadas. Para más opciones de configuración para el cliente, por favor consulta Configurar Cliente.

Requisitos Previos

• Cuenta de upgradeLink registrada.
• AccessKey y AccessSecret obtenidos.
• Estrategia de actualización de aplicación URL configurada.

Obtener Credenciales

Instalar SDK

Ejecuta el siguiente comando para instalar el SDK:

npm install @toolsetlink/upgradelink-api-typescript

Verificar SDK

Puedes usar el siguiente comando para verificar la instalación y consultar su versión:

 npm view @toolsetlink/upgradelink-api-typescript versions

Un ejemplo de retorno exitoso se muestra a continuación, lo que indica que has instalado correctamente:

 1.5.0

Uso Rápido

El siguiente programa de ejemplo demuestra cómo inicializar un Client y recuperar la información de actualización más reciente para una aplicación URL.

Obtener Información de Actualización Más Reciente de Aplicación URL

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


// Probar obtención de información de actualización URL
async function testGetUrlUpgrade() {
    try {
         // Inicializar cliente
        const config = new Config({
            accessKey:  'mui2W50H1j-OC4xD6PgQag',
            accessSecret: 'PEbdHFGC0uO_Pch7XWBQTMsFRxKPQAM2565eP8LJ3gc',
        });
        const client = new Client(config);

        // Construir parámetros de solicitud
        const request = new UrlUpgradeRequest({
            urlKey: 'uJ47NPeT7qjLa1gL3sVHqw',
            versionCode: 1,
            appointVersionCode: 0,
            devModelKey: '',
            devKey: ''
        });

        // Enviar solicitud
        const response = await client.UrlUpgrade(request);

        // Imprimir resultados de la respuesta
        console.log('\nRespuesta de información de actualización URL:');
        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('\nError al obtener información de actualización URL:', error);
    }
}