Быстрый старт с Python SDK

В этой статье представлено руководство быстрого старта по использованию Python SDK для выполнения обычных операций. Вы узнаете, как установить SDK, настроить учетные данные доступа и выполнить базовые операции, такие как получение последней информации об обновлении.

Примечания

• При выполнении запросов с помощью Python SDK вам нужно инициализировать экземпляр Client. В этой статье создается Client путем загрузки стандартных конфигураций. Для получения дополнительных вариантов конфигурации клиента обратитесь к разделу Настройка клиента.

Предварительные требования

• Зарегистрирована учетная запись UpgradeLink.
• Получены AccessKey и AccessSecret.
• Настроена стратегия обновления URL-приложения.

Получение учетных данных

Установка Python SDK

• Сначала установите среду компиляции и запуска Python. Проверьте успешность установки Python с помощью следующей команды:

  python --version

Если в настоящее время у вас нет подходящей среды компиляции и запуска Python, обратитесь к инструкциям по установке Python для загрузки и установки.

• Выполните следующую команду для установки пакета кода Python SDK.

pip install upgradelink-api-python

• Используйте следующий код для импорта пакета кода Python SDK.

import upgradelink_api_python

Быстрый прием использования

В следующей примерной программе демонстрируется, как инициализировать Client и получить последнюю информацию об обновлении для URL-приложения.

Получение последней информации об обновлении для URL-приложения

from upgradelink_api_python import models as upgrade_link_models
from upgradelink_api_python.client import Client

def main():
    # Создание объекта конфигурации
    config = upgrade_link_models.Config(
        access_key="mui2W50H1j-OC4xD6PgQag",  # Пример ключа, пожалуйста, замените своим фактическим ключом
        access_secret="PEbdHFGC0uO_Pch7XWBQTMsFRxKPQAM2565eP8LJ3gc",  # Пример ключа, пожалуйста, замените своим фактическим ключом
        protocol="HTTPS",
        endpoint="api.upgrade.toolsetlink.com"
    )
    
    # Создание клиента
    client = Client(config)
    
    # Установка параметров запроса
    url_key = "uJ47NPeT7qjLa1gL3sVHqw"  # Уникальный идентификатор для URL-приложения
    version_code = 1  # Текущий номер версии приложения
    appoint_version_code = 0  # Указанный номер версии, 0 означает последнюю версию
    dev_model_key = ""  # Идентификатор модели устройства, необязательно
    dev_key = ""  # Идентификатор устройства, необязательно
    
    # Создание объекта запроса
    request = upgrade_link_models.UrlUpgradeRequest(
        url_key=url_key,
        version_code=version_code,
        appoint_version_code=appoint_version_code,
        dev_model_key=dev_model_key,
        dev_key=dev_key
    )
    
    try:
        # Вызов API-интерфейса
        response = client.url_upgrade(request)
        
        # Обработка результата ответа
        if response.code == 200:
            print("Request successful!")
            print(f"Message: {response.msg}")
            print(f"Trace ID: {response.trace_id}")
            
            # Обработка данных об обновлении
            if response.data:
                data = response.data
                print("\nUpgrade Information:")
                print(f"URL Key: {data.url_key}")
                print(f"Version Name: {data.version_name}")
                print(f"Version Code: {data.version_code}")
                print(f"URL Path: {data.url_path}")
                print(f"Upgrade Type: {data.upgrade_type}")  # 1: Принудительное обновление, 2: Рекомендуемое обновление, 3: Опциональное обновление
                print(f"Upgrade Prompt Content: {data.prompt_upgrade_content}")
                
                # Обработка различных типов обновлений
                if data.upgrade_type == 1:
                    print("\nThis is a forced upgrade. Please upgrade the application immediately.")
                    # Выполнение логики принудительного обновления
                elif data.upgrade_type == 2:
                    print("\nThis is a recommended upgrade. It is recommended that users upgrade the application.")
                    # Выполнение логики рекомендуемого обновления
                elif data.upgrade_type == 3:
                    print("\nThis is an optional upgrade. Users can choose whether to upgrade.")
                    # Выполнение логики опционального обновления
        else:
            print(f"Request failed, error code: {response.code}")
            print(f"Error message: {response.msg}")
            print(f"Trace ID: {response.trace_id}")
            
    except Exception as e:
        print(f"Error occurred when calling API: {e}")

if __name__ == "__main__":
    main()