Začněte

Povolte přístup, vytvořte přihlašovací údaje a proveďte svůj první požadavek API.

1. Zapněte přístup k rozhraní API

   Vlastník organizace povolí přístup k API a MCP v Nastavení. Sdílený doplněk stojí 20 USD na organizaci za kalendářní měsíc pro cloud a propojené instalace s vlastním hostováním. Během zkušební doby se v Nastavení zobrazuje, zda je zahrnut přístup k API a MCP. Pokud se zobrazuje možnost Zahrnuto ve zkušební verzi, povolte přístup tam; v opačném případě zkontrolujte možnost placené aktivace. Zakázání placeného přístupu neodstraní poplatek za aktuální měsíc.

   Pro Self-Hosted povolte doplněk ve vaší vlastní cloudové organizaci, nechte instalaci dokončit registraci licence a poté povolte přístup k API v Nastavení instalace. V těchto příkladech použijte místo adresy Cloud API vlastní HTTPS adresu instalace.

2. Vytvořte přihlašovací údaje

   V Nastavení vytvořte pověření API. Začněte s inventářem pouze pro tento návod. Vyberte si jako oblast působnosti celou organizaci nebo jednu společnost. Rozsah nelze později změnit; Pokud potřebujete jiný rozsah, vytvořte nové pověření.

3. Uložte tajemství

   Pověření API má uživatelské jméno a tajemství. Tajenka se zobrazí pouze tehdy, když ji vytvoříte nebo otočíte. Uložte jej do správce hesel nebo do tajného úložiště. Je opakovaně použitelný až do odvolání nebo vypršení platnosti; nejedná se o jednorázový ověřovací kód ani vaše přihlašovací heslo.

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

Autentizace →

Oprávnění a rozsah

Předvolba vybírá možnosti, nikoli úroveň přístupu. Nastavení vytváří nové přihlašovací údaje pomocí FullAccess; vybrané možnosti stále omezují přístup. Před uložením zkontrolujte vlastní oprávnění. ReadOnly a ReadWrite popisují starší nebo samostatně vytvořené přihlašovací údaje, nikoli názvy předvoleb.

Organizace, společnost a místo

Organizace je hranice nejvyšší úrovně vašeho účtu. Společnosti v něm oddělují zákazníky nebo obchodní jednotky. Weby seskupují zařízení v rámci společnosti. Pověření v rozsahu společnosti nemá přístup k datům jiné společnosti.