RemoteGymp · API v1

ప్రమాణీకరణ

మీ క్రెడెన్షియల్ యొక్క వినియోగదారు పేరు మరియు రహస్యాన్ని టోకెన్ ఎండ్ పాయింట్‌కి పంపండి. ఈ మార్పిడికి బేరర్ టోకెన్ అవసరం లేదు. తదుపరి 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
మళ్లీ ప్రయత్నించే ముందు ప్రతిస్పందన హెడర్‌లో ఇవ్వబడిన ఆలస్యం కోసం వేచి ఉండండి. డిఫాల్ట్ టోకెన్-ప్రయత్న పరిమితి ప్రతి రిలేలో నిమిషానికి సోర్స్ IPకి 10. ప్లాట్‌ఫారమ్ సెట్టింగ్‌లు ఈ పరిమితిని మార్చగలవు.

API సూచిక → POST /v1/auth/token

AI అసిస్టెంట్‌ని కనెక్ట్ చేయండి →

కంటెంట్ రివిజన్ 3f225a253 · OpenAPI SHA-256: b12c42306a89