اپنے اسناد کا صارف نام اور راز ٹوکن اینڈ پوائنٹ پر بھیجیں۔ اس تبادلے کو بیئرر ٹوکن کی ضرورت نہیں ہے۔ بعد میں آنے والی REST درخواستوں پر واپس کردہ رسائی ٹوکن کو بطور بیئرر ٹوکن استعمال کریں۔
password: یہ JSON فیلڈ آپ کے API کی اسناد کا راز رکھتا ہے، آپ کے اکاؤنٹ کا لاگ ان پاس ورڈ نہیں۔
اپنی پہلی درخواست کریں۔
مقامی طور پر مثال چلائیں۔ یہ آپ کی اسناد کے لیے اشارہ کرتا ہے، ایک رسائی ٹوکن حاصل کرتا ہے اور آلات کے پہلے صفحے کی فہرست دیتا ہے۔ ٹوکن کو نجی رکھیں۔ یہ دستاویزات کے صفحات کبھی بھی اسناد طلب یا ذخیرہ نہیں کرتے ہیں۔
ایک زبان کا انتخاب کریں اور ذیل میں درج انحصار کو انسٹال کریں۔ مثالیں کلاؤڈ 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 فی منٹ ہے۔ پلیٹ فارم کی ترتیبات اس حد کو تبدیل کر سکتی ہیں۔