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

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

نکات

• هنگام ارسال درخواست‌ها با استفاده از Python SDK، نیاز به راه‌اندازی یک نمونه Client دارید. این مقاله Client را با بارگذاری پیکربندی‌های پیش‌فرض ایجاد می‌کند. برای گزینه‌های پیکربندی بیشتر در مورد کلاینت، به Configuring the Client مراجعه کنید.

پیش‌نیازها

• حساب upgradeLink را ثبت کرده‌اید.
• AccessKey و AccessSecret را به‌دست آورده‌اید.
• استراتژی به‌روزرسانی برنامه URL را پیکربندی کرده‌اید.

دریافت اعتبارها

نصب Python SDK

• لطفاً ابتدا محیط کامپایل و اجرای Python را نصب کنید. با استفاده از دستور زیر بررسی کنید که آیا Python با موفقیت نصب شده:

  python --version

اگر در حال حاضر محیط کامپایل و اجرای مناسب Python ندارید، برای دانلود و نصب به Python Installation مراجعه کنید.

• دستور زیر را اجرا کنید تا بسته کد 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("درخواست موفق!")
            print(f"پیام: {response.msg}")
            print(f"Trace ID: {response.trace_id}")
            
            # پردازش داده‌های به‌روزرسانی
            if response.data:
                data = response.data
                print("\nاطلاعات به‌روزرسانی:")
                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("\nاین یک ارتقا اجباری است. لطفاً فوراً برنامه را به‌روزرسانی کنید.")
                    # اجرای منطق ارتقا اجباری
                elif data.upgrade_type == 2:
                    print("\nاین یک ارتقا توصیه شده است. توصیه می‌شود که کاربران برنامه را به‌روزرسانی کنند.")
                    # اجرای منطق ارتقا توصیه شده
                elif data.upgrade_type == 3:
                    print("\nاین یک ارتقا اختیاری است. کاربران می‌توانند انتخاب کنند که آیا ارتقا کنند یا خیر.")
                    # اجرای منطق ارتقا اختیاری
        else:
            print(f"درخواست ناموفق، کد خطا: {response.code}")
            print(f"پیام خطا: {response.msg}")
            print(f"Trace ID: {response.trace_id}")
            
    except Exception as e:
        print(f"خطا در هنگام فراخوانی API: {e}")

if __name__ == "__main__":
    main()