RemoteGymp · API v1

Hitelesítés

Küldje el hitelesítő adatainak felhasználónevét és titkát a token végpontnak. Ehhez a cseréhez nincs szükség bemutató tokenre. Használja a visszaadott hozzáférési jogkivonatot vivőjogkivonatként a következő REST kérésekhez.

password: Ez a JSON-mező tartalmazza az API-hitelesítési adatok titkát, nem pedig a fiók bejelentkezési jelszavát.

Tedd fel az első kérésedet

Futtassa a példát helyben. Megkéri a hitelesítési adatokat, hozzáférési tokent kap, és felsorolja az eszközök első oldalát. Tartsa privátban a tokent. Ezek a dokumentációs oldalak soha nem kérnek vagy tárolnak hitelesítő adatokat.

Válasszon nyelvet, és telepítse az alább felsorolt ​​függőségeket. A példák a Cloud API-címet használják. Soha ne illesszen be valódi titkokat a dokumentációba, támogatási jegyekbe vagy megosztott naplókba.

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

Hozzáférési token válasz

A hitelesítő adatcsere az alábbi mezőket adja vissza. Az itt látható token egy helyőrző. Az élettartam másodpercben van megadva, a lejárati időbélyeg pedig UTC.

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

A hitelesítő adatokkal kiadott tokenek 30 percig tartanak. Ez a csere nem ad vissza frissítési tokent. Ha egy token lejár, cserélje ki újra a hitelesítő adatokat. Megszakított írás esetén ellenőrizze annak eredményét és a végpont újrapróbálkozási szabályait, mielőtt újra elküldené.

Válassza ki, hol használható a hozzáférési token

audience: "api"
Használja ezt az értéket a REST API kérésekhez. Ez az alapértelmezett, ha a közönségmező ki van hagyva.
audience: "mcp"
Ezt az értéket csak vivőjogkivonattal konfigurált MCP-klienseknél használja. A hitelesítési adatokon engedélyezni kell az MCP-t. Az API és MCP tokenek nem használhatók felváltva.

Ha a hitelesítés sikertelen

401
Ellenőrizze a felhasználónevet és a titkot, a hitelesítő adatok lejáratát és visszavonását. Hitelesített kérés esetén ellenőrizze a token lejáratát és a közönséget is. Ugyanazon érvénytelen hitelesítő adatok megismétlése nem oldja meg a problémát.
403
Ellenőrizze a válaszkódot és az üzenetet. A hozzáférést az engedélyek, a hálózati vagy országszabályzat, a Tulajdonos jelenlegi hozzáférése vagy a kiegészítő jogosultsága blokkolhatja. Az új token nem kerüli meg ezeket az ellenőrzéseket.
429 · Retry-After
Mielőtt újra próbálkozna, várja meg a válaszfejlécben megadott késleltetést. Az alapértelmezett jogkivonat-kísérleti korlát 10 percenkénti forrás IP-címenként minden továbbításon. A platform beállításai módosíthatják ezt a korlátot.

API referencia → POST /v1/auth/token

Csatlakoztasson egy AI-asszisztenst →

Tartalom felülvizsgálata 3f225a253 · OpenAPI SHA-256: b12c42306a89