نمای کلی API اوربنت
API بکاند پلتفرم اصلی VPN با پروتکلهای REST، gRPC و WebSocket.
API اوربنت
بکاند اصلی که کل پلتفرم اوربویپیان را اجرا میکند. احراز هویت، کاربران، دستگاهها، اشتراکها، اتصال VPN، شبکه مش، اقتصاد توکن و بیشتر را از طریق پروتکلهای REST، gRPC و WebSocket مدیریت کنید.
آدرسهای پایه
| پروتکل | آدرس پایه | توضیح |
|---|---|---|
| REST | https://api.orbai.world | تمام نقاط پایانی REST |
| gRPC | grpc://api.orbai.world:50051 | سرویسهای gRPC با TLS |
| WebSocket | wss://api.orbai.world/ws | اعلانهای بیدرنگ و گفتوگو |
احراز هویت
تمام نقاط پایانی محافظتشده به یک توکن JWT از نوع Bearer در هدر Authorization نیاز دارند. توکن را از طریق نقطه پایانی ورود دریافت کنید.
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...چند روش احراز هویت
اوربنت از ورود با ایمیل و گذرواژه (JWT)، OAuth 2.0 (گوگل، اپل، گیتهاب)، کلید عبور (WebAuthn/FIDO2)، پیوند جادویی (ورود بدون گذرواژه از طریق ایمیل) و ورود با کد QR از دسکتاپ پشتیبانی میکند. برای همه روشها بخش احراز هویت را ببینید.
دستهبندیهای API
هر ۲۶ دسته API اوربنت را کاوش کنید. هر بخش مستندات کامل نقاط پایانی به همراه نمونه درخواست و پاسخ را دارد.
بخشهای مرجع فعلاً به انگلیسی هستند
صفحههای مرجع نقطهبهنقطهٔ زیر هنوز ترجمه نشدهاند و به نسخهٔ انگلیسی میروند. مسیرها، پارامترها و نمونههای کد در هر دو زبان یکساناند.
احراز هویت
ورود با JWT، OAuth، کلید عبور، پیوند جادویی، احراز هویت با کد QR، تازهسازی توکن و مدیریت نشست.
کاربران
پروفایل کاربر، ترجیحات، مدیریت تصویر پروفایل، تنظیمات حساب و عملیات مدیریتی روی کاربران.
VPN
پیکربندیهای WireGuard، VLESS و OrbConnect. نمایههای اتصال، اتصال سریع و جابهجایی میان پروتکلها.
سرورها
فهرست سرورها، جستوجوی موقعیت، توزیع بار، پیشنهاد بر پایه تأخیر و وضعیت سلامت سرور.
شروع سریع
در کمتر از یک دقیقه احراز هویت کنید و نخستین درخواست API خود را بفرستید.
/api/v1/auth/loginاحراز هویت و دریافت توکن دسترسی و توکن تازهسازی JWT
# گام ۱: ورود برای دریافت توکن JWT
curl -X POST https://api.orbai.world/api/v1/auth/login \
-H "Content-Type: application/json" \
-d '{
"email": "user@example.com",
"password": "your_password"
}'
# گام ۲: استفاده از توکن برای فهرست کردن سرورهای VPN
curl https://api.orbai.world/api/v1/servers \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"{
"success": true,
"data": {
"token": "eyJhbGciOiJIUzI1NiIs...",
"refreshToken": "dGhpcyBpcyBhIHJlZnJlc2...",
"expiresAt": "2026-02-09T12:00:00Z",
"user": {
"id": "usr_abc123",
"email": "user@example.com",
"role": "user",
"subscription": {
"plan": "premium",
"status": "active"
}
}
}
}نقاط پایانی کلیدی
پرکاربردترین نقاط پایانی API اوربنت برای شروع کار.
احراز هویت با ایمیل و گذرواژه، OAuth یا کلید عبور
ساخت حساب کاربری تازه با تأیید ایمیل
دریافت پروفایل کامل کاربر احراز هویتشده
دریافت همه موقعیتهای سرور VPN همراه با اطلاعات بار
ساخت پیکربندی WireGuard یا VLESS برای یک سرور
پشتیبانی از پروتکلها
API از نوع REST
بیش از ۳۰۰ نقطه پایانی در ۲۶ دسته. HTTPS استاندارد با بدنه درخواست و پاسخ JSON. مناسب برای وباپلیکیشنها، کلاینتهای موبایل و یکپارچهسازیهای شخص ثالث.
سرویسهای gRPC
بیش از ۴۹۰ RPC پرکارایی مبتنی بر Protocol Buffers، با استریم سمت سرور برای بهروزرسانی بیدرنگ. کلاینتهای بومی اوربویپیان برای ارتباط کمتأخیر با سرور از آن استفاده میکنند.
جریانهای WebSocket
دو نقطه پایانی WebSocket پایدار: یکی برای اعلانهای فوری و رویدادهای اتصال، دیگری برای گفتوگوی زنده پشتیبانی با هوش مصنوعی.
کدام پروتکل را انتخاب کنم؟
برای بیشتر یکپارچهسازیها، REST بهترین نقطه شروع است. وقتی به توان عملیاتی بالا یا قابلیت استریم نیاز دارید از gRPC استفاده کنید. وقتی میخواهید رویدادها بیدرنگ و بدون نظرسنجی مکرر برسند، WebSocket را به کار ببرید.
ساختن با اوربنت را آغاز کنید
بیش از ۳۰۰ نقطه پایانی REST، بیش از ۴۹۰ RPC از نوع gRPC و جریانهای بیدرنگ WebSocket. تمام توان پلتفرم اوربویپیان در دستان شما.