आरंभ करें

पहुंच सक्षम करें, एक क्रेडेंशियल बनाएं और अपना पहला एपीआई अनुरोध करें।

1. एपीआई एक्सेस चालू करें

   एक ऑर्गनाइज़ेशन ओनर सेटिंग्स में API और MCP एक्सेस इनेबल करता है। शेयर्ड ऐड-ऑन की कीमत क्लाउड और लिंक्ड सेल्फ़-होस्टेड इंस्टॉलेशन के लिए हर ऑर्गनाइज़ेशन के लिए हर कैलेंडर महीने में US$20 है। ट्रायल के दौरान, सेटिंग्स दिखाती है कि API और MCP एक्सेस शामिल है या नहीं। अगर यह ट्रायल में शामिल दिखाता है, तो वहां एक्सेस इनेबल करें; नहीं तो पेड एक्टिवेशन ऑप्शन देखें। पेड एक्सेस को डिसेबल करने से मौजूदा महीने का चार्ज नहीं हटता है।

   सेल्फ-होस्टेड के लिए, अपने स्वामित्व वाले क्लाउड संगठन में ऐड-ऑन सक्षम करें, इंस्टॉलेशन को अपना लाइसेंस चेक-इन पूरा करने दें, फिर इंस्टॉलेशन की सेटिंग्स में एपीआई एक्सेस सक्षम करें। इन उदाहरणों में क्लाउड एपीआई पते के बजाय इंस्टॉलेशन के स्वयं के HTTPS पते का उपयोग करें।

2. एक क्रेडेंशियल बनाएं

   सेटिंग्स में एक एपीआई क्रेडेंशियल बनाएं। इस वॉकथ्रू के लिए केवल इन्वेंटरी से शुरुआत करें। इसके दायरे के रूप में पूरे संगठन या एक कंपनी को चुनें। बाद में दायरा बदला नहीं जा सकता; यदि आपको भिन्न दायरे की आवश्यकता है तो एक नया क्रेडेंशियल बनाएं।

3. रहस्य सहेजें

   एपीआई क्रेडेंशियल में एक उपयोगकर्ता नाम और एक रहस्य होता है। रहस्य तभी दिखता है जब आप उसे बनाते या घुमाते हैं। इसे पासवर्ड मैनेजर या सीक्रेट स्टोर में सेव करें। यह निरस्त होने या समाप्त होने तक पुन: प्रयोज्य है; यह एक बार का सत्यापन कोड या आपका लॉगिन पासवर्ड नहीं है।

4. अपना पहला अनुरोध करें

   उदाहरण को स्थानीय रूप से चलाएँ। यह आपके क्रेडेंशियल के लिए संकेत देता है, एक एक्सेस टोकन प्राप्त करता है और उपकरणों के पहले पृष्ठ को सूचीबद्ध करता है। टोकन को निजी रखें. ये दस्तावेज़ीकरण पृष्ठ कभी भी क्रेडेंशियल नहीं मांगते या संग्रहीत नहीं करते।

   एक भाषा चुनें और नीचे सूचीबद्ध निर्भरताएँ स्थापित करें। उदाहरण क्लाउड एपीआई पते का उपयोग करते हैं। दस्तावेज़, समर्थन टिकट या साझा लॉग में कभी भी वास्तविक रहस्य न चिपकाएँ।

   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" }

प्रमाणीकरण →

अनुमतियाँ और दायरा

एक प्रीसेट कैपेबिलिटीज़ चुनता है, एक्सेस लेवल नहीं। सेटिंग्स FullAccess के साथ नए क्रेडेंशियल बनाती हैं; चुनी गई कैपेबिलिटीज़ अभी भी एक्सेस को रोकती हैं। सेव करने से पहले कस्टम परमिशन देखें। ReadOnly और ReadWrite पुराने या अलग से बनाए गए क्रेडेंशियल बताते हैं, प्रीसेट नाम नहीं।

संगठन, कंपनी और साइट

एक संगठन आपके खाते की शीर्ष-स्तरीय सीमा है। कंपनियां अपने भीतर ग्राहकों या व्यावसायिक इकाइयों को अलग करती हैं। साइटें एक कंपनी के भीतर उपकरणों का समूह बनाती हैं। एक कंपनी-स्कोप क्रेडेंशियल किसी अन्य कंपनी के डेटा तक नहीं पहुंच सकता है।