مقدمه

به SDK پایتون باسلام خوش آمدید - یک کتابخانه جامع برای تعامل با APIهای سرویس‌های باسلام. این SDK رابطی ساده، تمیز و توسعه‌دهنده‌پسند برای تمام سرویس‌های باسلام با پشتیبانی کامل Sync/Async فراهم می‌کند. این SDK پایتون طراحی شده تا ادغام با سرویس‌های باسلام را تا حد ممکن ساده و کارآمد کند. چه در حال ساخت یک ارتباط سرور به سرور باشید و چه در حال توسعه‌ یک اپلیکیشن کاربرمحور، این SDK ابزارهای مورد نیاز شما را فراهم می‌کند.

نسخه‌های پایتون پشتیبانی شده: Python 3.8+, Python 3.9+, Python 3.10+, Python 3.11+

ویژگی‌های کلیدی:

• پوشش جامع سرویس‌ها: دسترسی به تمام سرویس‌های باسلام شامل کیف پول، سفارش‌ها، گفت‌وگو و موارد دیگر
• روش‌های مختلف احراز هویت: پشتیبانی از گواهی‌نامه‌های کاربر (Client Credentials)، جریان کد مجوز (Authorization Code Flow) و توکن‌های دسترسی شخصی (PAT)
• تضمین نوع داده‌ها: استفاده از Pydantic برای بررسی و اعتبارسنجی دقیق نوع داده‌ها
• پشتیبانی کامل Async/Sync: پشتیبانی تمام متدها از الگوهای Sync و Async
• مدیریت خطا: کلاس‌های خطای دقیق برای انواع مختلف خطاها
• مناسب برای توسعه‌دهندگان: طراحی ساده و استاندارد API به‌همراه مستندات کامل و جامع

فهرست مطالب

• نصب
• شروع سریع
• روش‌های احراز هویت
• نمای کلی سرویس‌ها

نصب

SDK را با استفاده از pip نصب کنید:

pip install basalam-sdk

شروع سریع

۱. تنظیم احراز هویت

from basalam_sdk import BasalamClient, PersonalToken
 
# توکن دسترسی شخصی (PAT)
auth = PersonalToken(
    token="your-access-token",
    refresh_token="your-refresh-token"
)
 
# ایجاد کلاینت
client = BasalamClient(auth=auth)

۲. اولین فراخوانی‌های API شما

دریافت محصولات

# دریافت محصولات
products = client.get_products()
print(f"Found {len(products)} products")

ارسال پیام و دریافت گفت‌وگوها

# ایجاد یک پیام
from basalam_sdk.chat.models import MessageRequest
 
message = client.create_message(
    request=MessageRequest(
        chat_id=123,
        content="سلام، چطور می‌توانم کمکتان کنم؟",
        message_type=MessageTypeEnum.TEXT
    )
)
 
# دریافت پیام‌ها از یک گفت‌وگو
messages = client.get_messages(
    chat_id=123,
    limit=20,
    order="DESC"
)

نمای کلی سرویس‌ها

در SDK پایتون باسلام از تمامی ریسورس‌های سرویس‌های زیر به صورت یکپارچه‌سازی‌شده پشتیبانی شده است:

• سرویس مرکزی (کاربر، غرفه و محصول) - غرفه‌داران، محصولات، روش‌های ارسال و اطلاعات کاربر
• سرویس سفارش - مدیریت سبد خرید، پرداخت‌ها و فاکتورها
• سرویس رهگیری سفارش - سفارشات مشتری و غرفه‌داران
• سرویس کیف پول - مدیریت موجودی‌ها، هزینه‌ها و بازپرداخت‌های کاربر
• سرویس گفت‌وگو - عملکردهای پیام‌رسانی و چت باسلام
• سرویس آپلود - آپلود فایل
• سرویس سرچ - جست‌وجوی محصول
• سرویس وب‌هوک - مدیریت رخدادها و وب‌هوک