نام کاربری و راز اعتبار خود را به نقطه پایانی رمز ارسال کنید. این صرافی نیازی به توکن حامل ندارد. در درخواست‌های REST بعدی، از نشانه دسترسی برگشتی به عنوان نشانه حامل استفاده کنید.
password: این فیلد JSON حاوی رمز اعتبار API شما است، نه رمز ورود به حساب شما.
اولین درخواست خود را مطرح کنید
مثال را به صورت محلی اجرا کنید. اعتبار شما را درخواست می کند، رمز دسترسی را دریافت می کند و صفحه اول دستگاه ها را فهرست می کند. رمز را خصوصی نگه دارید. این صفحات اسناد هرگز اعتبارنامه را درخواست یا ذخیره نمی کنند.
یک زبان را انتخاب کنید و وابستگی های ذکر شده در زیر را نصب کنید. نمونه ها از آدرس Cloud API استفاده می کنند. هرگز اسرار واقعی را در اسناد، بلیط های پشتیبانی یا سیاهههای مربوط به اشتراک قرار ندهید.
cURL: Bash + jq · Python: requests · C#: .NET 8+ (HttpClient)
C#: dotnet new console → Program.cs → dotnet run
$credential = Get-Credential
$body = @{
username = $credential.UserName
password = $credential.GetNetworkCredential().Password
audience = "api"
} | ConvertTo-Json
$token = Invoke-RestMethod -Method Post -Uri "https://api.remotegymp.com/v1/auth/token" -ContentType "application/json" -Body $body
$env:RG_API_TOKEN = $token.accessToken
Invoke-RestMethod -Uri "https://api.remotegymp.com/v1/devices?pageSize=25" -Headers @{ Authorization = "Bearer $env:RG_API_TOKEN" }دسترسی به پاسخ نشانه
مبادله اعتبار فیلدهای زیر را برمی گرداند. نشانه نشان داده شده در اینجا یک مکان نگهدار است. طول عمر بر حسب ثانیه است و مهر زمانی انقضا UTC است.
{
"accessToken": "<access-token>",
"tokenType": "Bearer",
"expiresIn": 1800,
"expiresAtUtc": "2026-10-26T12:30:00Z"
}توکن های صادر شده توسط اعتبار 30 دقیقه دوام دارند. این صرافی توکن تازه‌سازی را برنمی‌گرداند. وقتی یک توکن منقضی شد، دوباره اعتبار را مبادله کنید. برای نوشتن قطع شده، قبل از ارسال مجدد، نتیجه آن و قوانین تلاش مجدد نقطه پایانی را بررسی کنید.
محل استفاده از نشانه دسترسی را انتخاب کنید
audience: "api"- از این مقدار برای درخواست های REST API استفاده کنید. زمانی که فیلد مخاطب حذف می شود، پیش فرض است.
audience: "mcp"- از این مقدار فقط برای یک کلاینت MCP که با توکن حامل پیکربندی شده است استفاده کنید. اعتبارنامه باید MCP را فعال کرده باشد. توکن های API و MCP را نمی توان به جای هم استفاده کرد.
اگر احراز هویت با شکست مواجه شد
- 401
- نام کاربری و راز، انقضای اعتبار و ابطال را بررسی کنید. در یک درخواست احراز هویت، انقضای نشانه و مخاطبان را نیز بررسی کنید. تکرار همان اعتبار نامعتبر مشکل را حل نمی کند.
- 403
- کد پاسخ و پیام را بررسی کنید. دسترسی ممکن است توسط مجوزها، خط مشی شبکه یا کشور، دسترسی فعلی مالک یا واجد شرایط بودن افزونه مسدود شود. یک توکن جدید آن چک ها را دور نمی زند.
- 429 ·
Retry-After - قبل از تلاش مجدد منتظر تأخیر ذکر شده در سرصفحه پاسخ باشید. محدودیت پیش‌فرض توکن تلاش 10 به ازای هر IP منبع در دقیقه در هر رله است. تنظیمات پلت فرم می تواند این محدودیت را تغییر دهد.