RemoteGymp · API v1

Autentificare

Trimiteți numele de utilizator și secretul acreditării dvs. la punctul final al simbolului. Acest schimb nu are nevoie de un jeton la purtător. Utilizați jetonul de acces returnat ca simbol purtător la solicitările REST ulterioare.

password: Acest câmp JSON conține secretul dvs. de autentificare API, nu parola de conectare a contului.

Fă prima ta cerere

Rulați exemplul local. Acesta vă solicită acreditările, obține un token de acces și listează prima pagină a dispozitivelor. Păstrați tokenul privat. Aceste pagini de documentație nu solicită și nu stochează niciodată acreditări.

Alegeți o limbă și instalați dependențele enumerate mai jos. Exemplele folosesc adresa Cloud API. Nu lipiți niciodată secrete reale în documentație, bilete de asistență sau jurnalele partajate.

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

Răspuns token de acces

Schimbul de acreditări returnează câmpurile de mai jos. Indicatorul afișat aici este un substituent. Durata de viață este în secunde, iar marcajul de expirare este UTC.

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

Tokenurile emise de acreditări durează 30 de minute. Acest schimb nu returnează un jeton de reîmprospătare. Când un token expiră, schimbați din nou acreditările. Pentru o scriere întreruptă, verificați rezultatul acesteia și regulile de reîncercare ale punctului final înainte de a o retrimite.

Alegeți unde poate fi utilizat jetonul de acces

audience: "api"
Utilizați această valoare pentru solicitările API REST. Este valoarea implicită atunci când câmpul de audiență este omis.
audience: "mcp"
Utilizați această valoare numai pentru un client MCP configurat cu un token purtător. Acreditările trebuie să aibă MCP activat. Tokenurile API și MCP nu pot fi utilizate în mod interschimbabil.

Dacă autentificarea eșuează

401
Verificați numele de utilizator și secretul, expirarea acreditării și revocarea. La o cerere autentificată, verificați și expirarea simbolului și audiența. Repetarea aceleiași acreditări nevalide nu va rezolva problema.
403
Verificați codul de răspuns și mesajul. Accesul poate fi blocat de permisiuni, de politica de rețea sau de țară, de accesul curent al Proprietarului sau de eligibilitatea pentru suplimente. Un nou jeton nu ocolește aceste verificări.
429 · Retry-After
Așteptați întârzierea dată în antetul răspunsului înainte de a încerca din nou. Limita implicită de încercare de simbol este de 10 pe IP sursă pe minut pe fiecare Releu. Setările platformei pot modifica această limită.

Referință API → POST /v1/auth/token

Conectați un asistent AI →

Revizuirea conținutului 3f225a253 · OpenAPI SHA-256: b12c42306a89