ప్రారంభించండి

యాక్సెస్‌ని ప్రారంభించండి, క్రెడెన్షియల్‌ను సృష్టించండి మరియు మీ మొదటి API అభ్యర్థన చేయండి.

1. API యాక్సెస్‌ని ఆన్ చేయండి

   ఒక సంస్థ యజమాని సెట్టింగ్స్‌లో API మరియు MCP యాక్సెస్‌ను ఎనేబుల్ చేస్తారు. క్లౌడ్ మరియు లింక్ చేయబడిన సెల్ఫ్-హోస్టెడ్ ఇన్‌స్టాలేషన్‌ల కోసం ఈ షేర్డ్ యాడ్-ఆన్ ధర ప్రతి సంస్థకు ప్రతి క్యాలెండర్ నెలకు US$20. ట్రయల్ సమయంలో, API మరియు MCP యాక్సెస్ చేర్చబడిందో లేదో సెట్టింగ్స్ చూపిస్తుంది. ఒకవేళ 'ట్రయల్‌లో చేర్చబడింది' అని చూపిస్తే, అక్కడ యాక్సెస్‌ను ఎనేబుల్ చేయండి; లేకపోతే పెయిడ్ యాక్టివేషన్ ఆప్షన్‌ను సమీక్షించండి. పెయిడ్ యాక్సెస్‌ను డిసేబుల్ చేయడం వలన ప్రస్తుత నెల ఛార్జీ తొలగించబడదు.

   స్వీయ-హోస్ట్ కోసం, మీ స్వంత క్లౌడ్ ఆర్గనైజేషన్‌లో యాడ్-ఆన్‌ను ప్రారంభించండి, ఇన్‌స్టాలేషన్ దాని లైసెన్స్ చెక్-ఇన్‌ను పూర్తి చేయనివ్వండి, ఆపై ఇన్‌స్టాలేషన్ సెట్టింగ్‌లలో 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 పాత లేదా విడిగా సృష్టించిన క్రెడెన్షియల్‌లను వివరిస్తాయి, ప్రీసెట్ పేర్లను కాదు.

సంస్థ, కంపెనీ మరియు సైట్

సంస్థ అనేది మీ ఖాతా యొక్క ఉన్నత-స్థాయి సరిహద్దు. కంపెనీలు దానిలోని కస్టమర్‌లు లేదా వ్యాపార విభాగాలను వేరు చేస్తాయి. సైట్‌లు కంపెనీలోని పరికరాలను సమూహపరుస్తాయి. కంపెనీ-స్కోప్డ్ క్రెడెన్షియల్ మరొక కంపెనీ డేటాను యాక్సెస్ చేయదు.