RemoteGymp · API v1

Autentisering

Skicka inloggningsuppgifternas användarnamn och hemlighet till tokenslutpunkten. Detta utbyte behöver ingen bärarpolett. Använd den returnerade åtkomsttoken som en bärartoken vid efterföljande REST-förfrågningar.

password: Detta JSON-fält innehåller din API-inloggningshemlighet, inte ditt kontoinloggningslösenord.

Gör din första förfrågan

Kör exemplet lokalt. Den frågar efter din referens, erhåller en åtkomsttoken och listar den första sidan med enheter. Håll token privat. Dessa dokumentationssidor ber aldrig om eller lagrar referenser.

Välj ett språk och installera de beroenden som anges nedan. Exemplen använder Cloud API-adressen. Klistra aldrig in riktiga hemligheter i dokumentation, supportärenden eller delade loggar.

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

Svar på åtkomsttoken

Autentiseringsutbytet returnerar fälten nedan. Token som visas här är en platshållare. Livslängden är i sekunder och utgångstiden är UTC.

{
  "accessToken": "<access-token>",
  "tokenType": "Bearer",
  "expiresIn": 1800,
  "expiresAtUtc": "2026-10-26T12:30:00Z"
}

Behörighetsutfärdade tokens varar i 30 minuter. Detta utbyte returnerar inte en uppdateringstoken. När en token löper ut byter du autentiseringsuppgifterna igen. För en avbruten skrivning, kontrollera dess resultat och slutpunktens återförsöksregler innan du skickar in den igen.

Välj var åtkomsttoken kan användas

audience: "api"
Använd detta värde för REST API-förfrågningar. Det är standard när målgruppsfältet utelämnas.
audience: "mcp"
Använd endast detta värde för en MCP-klient som är konfigurerad med en bärartoken. Autentiseringsuppgifterna måste ha MCP aktiverat. API- och MCP-tokens kan inte användas omväxlande.

Om autentiseringen misslyckas

401
Kontrollera användarnamnet och hemligheten, autentiseringsuppgifternas utgång och återkallelse. På en autentiserad begäran, kontrollera även tokens utgång och målgrupp. Att upprepa samma ogiltiga autentiseringsuppgifter kommer inte att lösa problemet.
403
Kontrollera svarskoden och meddelandet. Åtkomst kan blockeras av behörigheter, nätverks- eller landspolicy, ägarens nuvarande åtkomst eller tilläggsbehörighet. En ny token går inte förbi dessa kontroller.
429 · Retry-After
Vänta på fördröjningen i svarshuvudet innan du försöker igen. Standardgränsen för tokenförsök är 10 per käll-IP per minut på varje relä. Plattformsinställningar kan ändra denna gräns.

API-referens → POST /v1/auth/token

Anslut en AI-assistent →

Innehållsrevision 3f225a253 · OpenAPI SHA-256: b12c42306a89