Alex-Devera/3x-ui
1
0
Fork 0
mirror of https://github.com/MHSanaei/3x-ui.git synced 2025-04-19 21:42:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

- Added persian docs

Browse source
This commit is contained in:
Аlexander Kiselev 2025-02-07 10:13:55 +03:00
parent e1569e2cad
commit f79602ae74
1 changed files with 137 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

137
docs/API.fa.md Normal file
View file

@ -0,0 +1,137 @@
# مستندات API
## ورودی‌ها (Inbounds)
### دریافت تمام ورودی‌ها
- **متد**: `GET`
- **اندپوینت**: `/inbounds/`
- **توضیحات**: دریافت لیستی از تمام ورودی‌ها.
### بازنشانی ترافیک تمام کاربران
- **متد**: `DELETE`
- **اندپوینت**: `/inbounds/traffic`
- **توضیحات**: بازنشانی ترافیک تمام کاربران.
---
## ورودی (Inbound)
### افزودن ورودی
- **متد**: `POST`
- **اندپوینت**: `/inbounds/`
- **توضیحات**: افزودن یک ورودی جدید.
### دریافت ورودی با شناسه (ID)
- **متد**: `GET`
- **اندپوینت**: `/inbounds/:id`
- **توضیحات**: دریافت اطلاعات یک ورودی خاص بر اساس شناسه آن.
### حذف ورودی با شناسه (ID)
- **متد**: `DELETE`
- **اندپوینت**: `/inbounds/:id`
- **توضیحات**: حذف ورودی بر اساس شناسه آن.
### به‌روزرسانی ورودی با شناسه (ID)
- **متد**: `PUT`
- **اندپوینت**: `/inbounds/:id`
- **توضیحات**: به‌روزرسانی اطلاعات یک ورودی بر اساس شناسه آن.
### حذف ترافیک ورودی
- **متد**: `DELETE`
- **اندپوینت**: `/inbounds/:id/traffic`
- **توضیحات**: حذف ترافیک ورودی بر اساس شناسه آن.
### حذف کاربران با ترافیک تمام‌شده
- **متد**: `DELETE`
- **اندپوینت**: `/inbounds/:id/depleted-clients`
- **توضیحات**: حذف کاربران با ترافیک مصرف‌شده برای یک ورودی خاص.
---
## کاربران ورودی
### دریافت کاربران ورودی
- **متد**: `GET`
- **اندپوینت**: `/inbounds/:id/clients/`
- **توضیحات**: دریافت لیست کاربران برای یک ورودی خاص.
---
## کاربر ورودی
### افزودن کاربر ورودی
- **متد**: `POST`
- **اندپوینت**: `/inbounds/:id/clients`
- **توضیحات**: افزودن یک کاربر جدید به ورودی.
### دریافت کاربر با شناسه (ID)
- **متد**: `GET`
- **اندپوینت**: `/inbounds/:id/clients/:clientId`
- **توضیحات**: دریافت اطلاعات کاربر بر اساس شناسه آن.
### به‌روزرسانی کاربر ورودی
- **متد**: `PUT`
- **اندپوینت**: `/inbounds/:id/clients/:clientId`
- **توضیحات**: به‌روزرسانی اطلاعات کاربر بر اساس شناسه آن.
### حذف کاربر ورودی
- **متد**: `DELETE`
- **اندپوینت**: `/inbounds/:id/clients/:clientId`
- **توضیحات**: حذف کاربر بر اساس شناسه آن.
### دریافت ترافیک کاربر با شناسه (ID)
- **متد**: `GET`
- **اندپوینت**: `/inbounds/:id/clients/:clientId/traffic`
- **توضیحات**: دریافت آمار ترافیک کاربر بر اساس شناسه آن.
---
## کاربر ورودی با ایمیل
### دریافت کاربر با ایمیل
- **متد**: `GET`
- **اندپوینت**: `/inbounds/:id/clients/email/:email`
- **توضیحات**: دریافت اطلاعات کاربر بر اساس ایمیل.
### دریافت IPهای کاربر
- **متد**: `GET`
- **اندپوینت**: `/inbounds/:id/clients/email/:email/ips`
- **توضیحات**: دریافت لیست آدرس‌های IP کاربر بر اساس ایمیل.
### پاک کردن IPهای کاربر
- **متد**: `DELETE`
- **اندپوینت**: `/inbounds/:id/clients/email/:email/ips`
- **توضیحات**: پاک کردن لیست آدرس‌های IP کاربر بر اساس ایمیل.
### دریافت ترافیک کاربر با ایمیل
- **متد**: `GET`
- **اندپوینت**: `/inbounds/:id/clients/email/:email/traffic`
- **توضیحات**: دریافت آمار ترافیک کاربر بر اساس ایمیل.
### بازنشانی ترافیک کاربر با ایمیل
- **متد**: `DELETE`
- **اندپوینت**: `/inbounds/:id/clients/email/:email/traffic`
- **توضیحات**: بازنشانی ترافیک کاربر بر اساس ایمیل.
---
## سایر موارد
### ایجاد نسخه پشتیبان
- **متد**: `GET`
- **اندپوینت**: `/inbounds/create-backup`
- **توضیحات**: ایجاد یک نسخه پشتیبان از داده‌ها.
### دریافت کاربران آنلاین
- **متد**: `GET`
- **اندپوینت**: `/inbounds/online`
- **توضیحات**: دریافت لیست کاربران آنلاین.
---
## سرور
### دریافت وضعیت سرور
- **متد**: `GET`
- **اندپوینت**: `/server/status`
- **توضیحات**: دریافت وضعیت سرور.