Send din legitimationsoplysningers brugernavn og hemmelighed til token-slutpunktet. Denne udveksling behøver ikke et ihændehavertegn. Brug det returnerede adgangstoken som et bærertoken på efterfølgende REST-anmodninger.
password: Dette JSON-felt bærer din API-legitimationshemmelighed, ikke din kontologin-adgangskode.
Lav din første anmodning
Kør eksemplet lokalt. Den beder om dine legitimationsoplysninger, får et adgangstoken og viser den første side med enheder. Hold tokenet privat. Disse dokumentationssider beder aldrig om eller gemmer aldrig legitimationsoplysninger.
Vælg et sprog og installer de afhængigheder, der er angivet nedenfor. Eksemplerne bruger Cloud API-adressen. Indsæt aldrig rigtige hemmeligheder i dokumentation, supportbilletter eller delte logfiler.
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å adgangstoken
Legitimationsudvekslingen returnerer felterne nedenfor. Tokenet vist her er en pladsholder. Levetiden er i sekunder, og udløbstidsstemplet er UTC.
{
"accessToken": "<access-token>",
"tokenType": "Bearer",
"expiresIn": 1800,
"expiresAtUtc": "2026-10-26T12:30:00Z"
}Legitimationsudstedte tokens varer 30 minutter. Denne udveksling returnerer ikke et opdateringstoken. Når et token udløber, skal du udskifte legitimationsoplysningerne igen. For en afbrudt skrivning skal du kontrollere resultatet og slutpunktets genforsøgsregler, før du sender det igen.
Vælg, hvor adgangstokenet kan bruges
audience: "api"- Brug denne værdi til REST API-anmodninger. Det er standard, når målgruppefeltet er udeladt.
audience: "mcp"- Brug kun denne værdi for en MCP-klient, der er konfigureret med et bærertoken. Legitimationsoplysningerne skal have MCP aktiveret. API- og MCP-tokens kan ikke bruges i flæng.
Hvis godkendelse mislykkes
- 401
- Tjek brugernavnet og hemmeligheden, legitimationsoplysningernes udløb og tilbagekaldelse. På en godkendt anmodning skal du også kontrollere tokens udløb og publikum. Gentagelse af det samme ugyldige legitimationsoplysninger løser ikke problemet.
- 403
- Tjek svarkoden og beskeden. Adgang kan være blokeret af tilladelser, netværks- eller landepolitik, ejerens nuværende adgang eller berettigelse til tilføjelser. Et nyt token omgår ikke disse kontroller.
- 429 ·
Retry-After - Vent på forsinkelsen angivet i svarhovedet, før du prøver igen. Standardgrænsen for token-forsøg er 10 pr. kilde-IP pr. minut på hvert relæ. Platformindstillinger kan ændre denne grænse.