अपने क्रेडेंशियल का उपयोगकर्ता नाम और रहस्य टोकन एंडपॉइंट पर भेजें। इस एक्सचेंज को बियरर टोकन की आवश्यकता नहीं है। बाद के REST अनुरोधों पर लौटाए गए एक्सेस टोकन को बियरर टोकन के रूप में उपयोग करें।
password: यह JSON फ़ील्ड आपके एपीआई क्रेडेंशियल रहस्य को रखता है, न कि आपके खाते के लॉगिन पासवर्ड को।
अपना पहला अनुरोध करें
उदाहरण को स्थानीय रूप से चलाएँ। यह आपके क्रेडेंशियल के लिए संकेत देता है, एक एक्सेस टोकन प्राप्त करता है और उपकरणों के पहले पृष्ठ को सूचीबद्ध करता है। टोकन को निजी रखें. ये दस्तावेज़ीकरण पृष्ठ कभी भी क्रेडेंशियल नहीं मांगते या संग्रहीत नहीं करते।
एक भाषा चुनें और नीचे सूचीबद्ध निर्भरताएँ स्थापित करें। उदाहरण क्लाउड एपीआई पते का उपयोग करते हैं। दस्तावेज़, समर्थन टिकट या साझा लॉग में कभी भी वास्तविक रहस्य न चिपकाएँ।
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"- इस मान का उपयोग केवल बियरर टोकन के साथ कॉन्फ़िगर किए गए एमसीपी क्लाइंट के लिए करें। क्रेडेंशियल में एमसीपी सक्षम होना चाहिए। एपीआई और एमसीपी टोकन का परस्पर उपयोग नहीं किया जा सकता है।
यदि प्रमाणीकरण विफल हो जाता है
- 401
- उपयोगकर्ता नाम और रहस्य, क्रेडेंशियल समाप्ति और निरसन की जाँच करें। प्रमाणित अनुरोध पर, टोकन समाप्ति और दर्शकों की भी जांच करें। उसी अमान्य क्रेडेंशियल को दोहराने से समस्या ठीक नहीं होगी.
- 403
- प्रतिक्रिया कोड और संदेश की जाँच करें। अनुमतियों, नेटवर्क या देश नीति, स्वामी की वर्तमान पहुंच, या ऐड-ऑन पात्रता द्वारा पहुंच को अवरुद्ध किया जा सकता है। एक नया टोकन उन चेकों को बायपास नहीं करता है।
- 429 ·
Retry-After - दोबारा प्रयास करने से पहले प्रतिक्रिया शीर्षलेख में दिए गए विलंब की प्रतीक्षा करें। प्रत्येक रिले पर डिफ़ॉल्ट टोकन-प्रयास सीमा 10 प्रति स्रोत आईपी प्रति मिनट है। प्लेटफ़ॉर्म सेटिंग इस सीमा को बदल सकती हैं.