سه سرویس، یک سکو

سکوی API در OrbVPN به سه سرویس تخصصی سامان یافته که هر کدام نیروی جنبهٔ متفاوتی از سکو را تأمین می‌کند.

نشانی‌های پایه

شروع سریع

در کمتر از ۵ دقیقه راه بیفتید.

احراز هویت

همهٔ نقاط پایانی محافظت‌شده به یک رمزینهٔ حامل JWT در سرآیند Authorization نیاز دارند.

curl -X POST https://api.orbai.world/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "your_password"
  }'

{
  "success": true,
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIs...",
    "refreshToken": "dGhpcyBpcyBhIHJlZnJlc2...",
    "expiresAt": "2026-02-08T12:00:00Z",
    "user": {
      "id": "usr_abc123",
      "email": "user@example.com",
      "role": "user"
    }
  }
}

سپس رمزینه را در درخواست‌های بعدی بگنجانید:

curl https://api.orbai.world/api/v1/users/me \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

پشتیبانی از پروتکل‌ها

OrbVPN از سه پروتکل ارتباطی پشتیبانی می‌کند. متناسب با کاربرد خود درست را برگزینید.

رسیدگی به خطا

همهٔ پاسخ‌های API از قالبی یکسان پیروی می‌کنند:

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Email address is required",
    "details": {
      "field": "email",
      "constraint": "required"
    }
  }
}

برای همهٔ کدهای خطا مرجع کامل خطاها را ببینید.

محدودسازی نرخ

درخواست‌های API برای تضمین استفادهٔ منصفانه محدود می‌شوند. سقف‌ها بسته به نقطهٔ پایانی و ردهٔ احراز هویت متفاوت‌اند.

سرآیندهای محدودسازی نرخ در هر پاسخ گنجانده می‌شوند:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1707350400

برای راهبردهای تلاش دوباره و بهترین شیوه‌ها راهنمای کامل محدودسازی نرخ را ببینید.

کاوش در API

ابزارهای توسعه