این پروژه شامل یک کلاینت پایتون برای API سرویس Marzban است مرزبان یک پنل مدیریت پروکسی است که امکان مدیریت چند صد حساب پروکسی را با قدرت و دسترسی بالا فراهم میکند. این کلاینت تمامی سرویس‌های موجود در API مرزبان را به‌صورت کامل پیاده‌سازی کرده و امکان استفاده آسان از توابع مختلف آن را در اختیار توسعه‌دهندگان قرار می‌دهد.
- مدیریت کامل کاربران: اضافه، ویرایش، حذف و دریافت اطلاعات کاربران.
- مدیریت ادمین: امکان ایجاد، حذف، و ویرایش ادمین‌ها.
- دسترسی به وضعیت سیستم: مشاهده وضعیت هسته‌ی سیستم، تنظیمات، آمار مصرف پهنای باند و...
- مدیریت گره‌ها (Nodes): امکان افزودن، ویرایش، حذف و دریافت اطلاعات گره‌های فعال.
- دریافت لینک اشتراک کاربران: تولید لینک‌های اشتراک مختلف برای دستگاه‌های گوناگون.
- قابلیت اتصال به Marzban API: دسترسی و استفاده از تمامی امکانات API به‌صورت متمرکز در قالب یک کلاینت پایتون.
- پایتون نسخه 3.8 یا بالاتر
- نصب کتابخانه‌های لازم که در بخش بعدی توضیح داده شده‌اند
۱. ابتدا این مخزن را کلون کنید:
git clone https://github.com/username/marzban-api-client.git
cd marzban-api-client۲. سپس پکیج‌های مورد نیاز را از طریق فایل requirements.txt نصب کنید:
pip install -r requirements.txtپس از نصب، می‌توانید از کلاینت API استفاده کنید. در زیر مثال‌هایی از نحوه‌ی استفاده از این کلاینت آورده شده است:
برای شروع، ابتدا نیاز دارید که توکن دسترسی را از API دریافت کنید. از این توکن برای تمام درخواست‌ها استفاده خواهد شد.
from marzban_api_client import MarzbanAPI
# مقداردهی اولیه کلاینت
api = MarzbanAPI(base_url="https://api.example.com")
# احراز هویت و دریافت توکن دسترسی
api.authenticate(username="admin", password="password")اضافه کردن کاربر جدید به Marzban:
from marzban_api_client.models import UserCreate
user_data = UserCreate(
username="new_user",
proxies={"vmess": {"id": "proxy_id"}},
expire=30, # تعداد روزهای اعتبار
data_limit=500, # محدودیت داده به مگابایت
)
new_user = api.add_user(user_data=user_data)
print("New User: ", new_user)برای دریافت وضعیت سیستم می‌توانید از کد زیر استفاده کنید:
system_stats = api.get_system_stats()
print("وضعیت سیستم:", system_stats)اضافه کردن گره جدید:
from marzban_api_client.models import NodeCreate
node_data = NodeCreate(name="New Node", address="192.168.1.1")
new_node = api.add_node(node_data=node_data)
print("گره جدید اضافه شد:", new_node)با استفاده از توکن کاربر، لینک اشتراک آن را دریافت کنید:
subscription = api.get_user_subscription(token="user_token")
print("لینک اشتراک کاربر:", subscription.subscription_url)اگر تمایل دارید که در توسعه این پروژه مشارکت کنید، مراحل زیر را دنبال کنید:
۱. این مخزن را فورک کنید. ۲. یک شاخه جدید ایجاد کنید:
git checkout -b feature/your-feature۳. تغییرات خود را اعمال کنید و کامیت کنید.
git commit -m "Add some feature"۴. تغییرات خود را به مخزن اصلی پوش کنید.
git push origin feature/your-feature۵. یک Pull Request ایجاد کنید.