RemoteGymp · API v1

Todennus

Lähetä valtuustietosi käyttäjänimi ja salaisuus tunnuksen päätepisteeseen. Tämä vaihto ei tarvitse siirtomerkkiä. Käytä palautettua käyttöoikeustunnusta siirtotietunnuksena seuraavissa REST-pyynnöissä.

password: Tämä JSON-kenttä sisältää API-tunnistetietojen salaisuuden, ei tilisi kirjautumissalasanaa.

Tee ensimmäinen pyyntösi

Suorita esimerkki paikallisesti. Se pyytää valtuustietojasi, hankkii pääsytunnuksen ja luetteloi laitteiden ensimmäisen sivun. Pidä tunnus yksityisenä. Näillä dokumentaatiosivuilla ei koskaan kysytä tai tallenneta valtuustietoja.

Valitse kieli ja asenna alla luetellut riippuvuudet. Esimerkeissä käytetään Cloud API -osoitetta. Älä koskaan liitä oikeita salaisuuksia dokumentaatioon, tukilippuihin tai jaettuihin lokeihin.

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

Käyttöoikeusvastaus

Valtuustietojen vaihto palauttaa alla olevat kentät. Tässä näkyvä tunnus on paikkamerkki. Käyttöikä on sekunneissa ja vanhenemisaikaleima on UTC.

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

Valtuustietojen myöntämät tunnukset kestävät 30 minuuttia. Tämä vaihto ei palauta päivitystunnusta. Kun tunnus vanhenee, vaihda valtuustiedot uudelleen. Jos kirjoitus on keskeytynyt, tarkista sen tulos ja päätepisteen uudelleenyrityssäännöt ennen kuin lähetät sen uudelleen.

Valitse, missä käyttöoikeustunnusta voidaan käyttää

audience: "api"
Käytä tätä arvoa REST API -pyyntöihin. Se on oletusarvo, kun yleisökenttä jätetään pois.
audience: "mcp"
Käytä tätä arvoa vain MCP-asiakkaalle, joka on määritetty siirtotietunnuksella. Tunnistetiedoissa on oltava MCP käytössä. API- ja MCP-tunnuksia ei voida käyttää keskenään.

Jos todennus epäonnistuu

401
Tarkista käyttäjänimi ja salaisuus, valtuustietojen vanheneminen ja peruutus. Tarkista myös tokenin vanheneminen ja yleisö todennetusta pyynnöstä. Saman virheellisen tunnistetietojen toistaminen ei korjaa ongelmaa.
403
Tarkista vastauskoodi ja viesti. Pääsy voidaan estää käyttöoikeuksien, verkko- tai maakäytäntöjen, omistajan nykyisen käyttöoikeuden tai lisäosien kelpoisuuden vuoksi. Uusi tunnus ei ohita näitä tarkistuksia.
429 · Retry-After
Odota vastauksen otsikossa ilmoitettua viivettä ennen kuin yrität uudelleen. Token-yritysten oletusraja on 10 lähde-IP-osoitetta minuutissa jokaisessa välityksessä. Alustaasetukset voivat muuttaa tätä rajaa.

API-viite → POST /v1/auth/token

Yhdistä AI-avustaja →

Sisällön versio 3f225a253 · OpenAPI SHA-256: b12c42306a89