प्रारंभ करा

प्रवेश सक्षम करा, क्रेडेन्शियल तयार करा आणि तुमची पहिली API विनंती करा.

1. API प्रवेश चालू करा

   ऑर्गनायझेशन ओनर सेटिंग्जमध्ये API आणि MCP ऍक्सेस सक्षम करतो. क्लाउड आणि लिंक्ड सेल्फ-होस्टेड इन्स्टॉलेशन्ससाठी या शेअर्ड ऍड-ऑनची किंमत प्रति ऑर्गनायझेशन प्रति कॅलेंडर महिना US$२० आहे. ट्रायल दरम्यान, API आणि MCP ऍक्सेस समाविष्ट आहे की नाही हे सेटिंग्जमध्ये दिसते. जर तेथे 'ट्रायलमध्ये समाविष्ट' (Included in trial) असे दिसत असेल, तर तेथे ऍक्सेस सक्षम करा; अन्यथा पेड ऍक्टिव्हेशन पर्यायाचे पुनरावलोकन करा. पेड ऍक्सेस अक्षम केल्याने चालू महिन्याचे शुल्क काढले जात नाही.

   सेल्फ-होस्टेडसाठी, तुमच्या मालकीच्या क्लाउड संस्थेमध्ये ॲड-ऑन सक्षम करा, इन्स्टॉलेशनला त्याचा परवाना चेक-इन पूर्ण करू द्या, नंतर इंस्टॉलेशनच्या सेटिंग्जमध्ये API प्रवेश सक्षम करा. या उदाहरणांमध्ये क्लाउड API पत्त्याऐवजी इंस्टॉलेशनचा स्वतःचा HTTPS पत्ता वापरा.

2. क्रेडेन्शियल तयार करा

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

3. गुपित जतन करा

   API क्रेडेंशियलमध्ये वापरकर्तानाव आणि गुप्तता असते. जेव्हा तुम्ही ते तयार करता किंवा फिरवता तेव्हाच रहस्य दर्शविले जाते. पासवर्ड मॅनेजर किंवा सिक्रेट्स स्टोअरमध्ये सेव्ह करा. रद्द किंवा कालबाह्य होईपर्यंत ते पुन्हा वापरण्यायोग्य आहे; हा एक-वेळ पडताळणी कोड किंवा तुमचा लॉगिन पासवर्ड नाही.

4. तुमची पहिली विनंती करा

   उदाहरण स्थानिक पातळीवर चालवा. ते तुमच्या क्रेडेन्शियलसाठी प्रॉम्प्ट करते, ऍक्सेस टोकन मिळवते आणि डिव्हाइसेसच्या पहिल्या पानाची सूची देते. टोकन खाजगी ठेवा. ही दस्तऐवजीकरण पृष्ठे कधीही क्रेडेन्शियल्सची मागणी करत नाहीत किंवा संग्रहित करत नाहीत.

   एक भाषा निवडा आणि खाली सूचीबद्ध अवलंबित्व स्थापित करा. उदाहरणे क्लाउड 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" }

प्रमाणीकरण →

परवानग्या आणि व्याप्ती

प्रीसेट क्षमता निवडतो, प्रवेश पातळी नाही. सेटिंग्ज FullAccess सह नवीन क्रेडेन्शियल्स तयार करते; निवडलेल्या क्षमता अजूनही प्रवेश प्रतिबंधित करतात. सेव्ह करण्यापूर्वी सानुकूल परवानग्या तपासा. ReadOnly आणि ReadWrite जुन्या किंवा स्वतंत्रपणे तयार केलेल्या क्रेडेन्शियल्सचे वर्णन करतात, प्रीसेट नावांचे नाही.

संस्था, कंपनी आणि साइट

संस्था ही तुमच्या खात्याची उच्च-स्तरीय सीमा असते. कंपन्या त्यामधील ग्राहक किंवा व्यवसाय युनिट वेगळे करतात. कंपनीमधील साइट गट उपकरणे. कंपनी-स्कॉप्ड क्रेडेंशियल दुसऱ्या कंपनीच्या डेटामध्ये प्रवेश करू शकत नाही.