RemoteGymp · API v1

Autentizace

Odešlete uživatelské jméno a tajný klíč svého pověření do koncového bodu tokenu. Tato výměna nepotřebuje token nosiče. Použijte vrácený přístupový token jako nosný token při následných požadavcích REST.

password: Toto pole JSON nese vaše tajemství pověření API, nikoli vaše přihlašovací heslo k účtu.

Zadejte svůj první požadavek

Spusťte příklad lokálně. Vyžádá si vaše přihlašovací údaje, získá přístupový token a zobrazí první stránku zařízení. Udržujte token v soukromí. Tyto stránky dokumentace nikdy nevyžadují ani neukládají přihlašovací údaje.

Vyberte jazyk a nainstalujte níže uvedené závislosti. Příklady používají adresu Cloud API. Nikdy nevkládejte skutečná tajemství do dokumentace, lístků podpory nebo sdílených protokolů.

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

Odezva přístupového tokenu

Výměna pověření vrátí pole níže. Zde zobrazený token je zástupný symbol. Životnost je v sekundách a časové razítko vypršení platnosti je UTC.

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

Pověřovací tokeny trvají 30 minut. Tato výměna nevrací obnovovací token. Když platnost tokenu vyprší, vyměňte přihlašovací údaje znovu. U přerušeného zápisu zkontrolujte jeho výsledek a pravidla opakování koncového bodu, než jej znovu odešlete.

Vyberte, kde lze přístupový token použít

audience: "api"
Tuto hodnotu použijte pro požadavky REST API. Je výchozí, když je vynecháno pole publika.
audience: "mcp"
Tuto hodnotu použijte pouze pro klienta MCP nakonfigurovaného s tokenem nosiče. Pověření musí mít povoleno MCP. Tokeny API a MCP nelze používat zaměnitelně.

Pokud se ověření nezdaří

401
Zkontrolujte uživatelské jméno a tajemství, vypršení platnosti pověření a odvolání. U ověřené žádosti také zkontrolujte vypršení platnosti tokenu a publikum. Opakování stejných neplatných přihlašovacích údajů problém nevyřeší.
403
Zkontrolujte kód odpovědi a zprávu. Přístup může být blokován oprávněními, zásadami sítě nebo země, aktuálním přístupem vlastníka nebo způsobilostí k doplňku. Nový token tyto kontroly neobchází.
429 · Retry-After
Než to zkusíte znovu, počkejte na zpoždění uvedené v hlavičce odpovědi. Výchozí limit pokusů o token je 10 na zdrojovou IP za minutu na každém relé. Nastavení platformy může tento limit změnit.

Referenční příručka API → POST /v1/auth/token

Připojte asistenta AI →

Revize obsahu 3f225a253 · OpenAPI SHA-256: b12c42306a89