Kezdje el

Engedélyezze a hozzáférést, hozzon létre egy hitelesítő adatot, és küldje el az első API-kérést.

1. Kapcsolja be az API-hozzáférést

   A szervezet tulajdonosa a Beállításokban engedélyezi a API és MCP hozzáférést. A megosztott bővítmény szervezetenként és naptári hónaponként 20 USD-ba kerül a felhőalapú és a kapcsolódó önállóan üzemeltetett telepítések esetén. Próbaidőszak alatt a Beállítások jelenítik meg, hogy a API és MCP hozzáférés benne van-e. Ha a „Próbaidőszak tartalmazza” felirat látható, engedélyezze a hozzáférést ott; ellenkező esetben tekintse át a fizetős aktiválási lehetőséget. A fizetős hozzáférés letiltása nem távolítja el az aktuális havi díjat.

   A Self-Hosted esetén engedélyezze a bővítményt a tulajdonos felhőszervezetében, hagyja, hogy a telepítés befejezze a licencbejelentkezést, majd engedélyezze az API-hozzáférést a telepítés beállításaiban. Használja a telepítés saját HTTPS-címét a Cloud API-cím helyett ezekben a példákban.

2. Hozzon létre egy hitelesítő adatot

   Hozzon létre egy API hitelesítő adatot a Beállításokban. Kezdje a készlettel, csak ehhez a bemutatóhoz. Válassza ki az egész szervezetet vagy egy vállalatot hatókörének. A hatókör később nem módosítható; hozzon létre egy új hitelesítő adatot, ha más hatókörre van szüksége.

3. Mentse el a titkot

   Az API-hitelesítési adatoknak van egy felhasználóneve és egy titka. A titok csak akkor jelenik meg, amikor létrehozza vagy elforgatja. Mentse el egy jelszókezelőbe vagy a titkok tárolójába. Visszavonásig vagy lejáratig újra felhasználható; ez nem egy egyszeri ellenőrző kód vagy a bejelentkezési jelszó.

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

Hitelesítés →

Engedélyek és hatókör

Az előbeállítások képességeket választanak ki, nem hozzáférési szintet. A beállítások új hitelesítő adatokat hoznak létre FullAccess értékkel; a kiválasztott képességek továbbra is korlátozzák a hozzáférést. Mentés előtt tekintse át az egyéni engedélyeket. A ReadOnly és ReadWrite régebbi vagy külön létrehozott hitelesítő adatokat írnak le, nem előre beállított neveket.

Szervezet, cég és telephely

A szervezet a fiók legfelső szintű határa. A vállalatok különálló ügyfeleket vagy üzleti egységeket tartalmaznak. A webhelyek egy vállalaton belül csoportosítják az eszközöket. A vállalati hatókörű hitelesítő adatok nem férhetnek hozzá egy másik vállalat adataihoz.