Zacznij

Włącz dostęp, utwórz dane uwierzytelniające i złóż pierwsze żądanie API.

1. Włącz dostęp API

   Właściciel organizacji włącza dostęp do API i MCP w Ustawieniach. Udostępniony dodatek kosztuje 20 USD za organizację miesięcznie dla instalacji w chmurze i powiązanych instalacji hostowanych samodzielnie. Podczas okresu próbnego w Ustawieniach jest wyświetlana informacja, czy dostęp do API i MCP jest uwzględniony. Jeśli wyświetlana jest opcja „Zawarte w okresie próbnym”, należy włączyć dostęp w tym miejscu; w przeciwnym razie należy sprawdzić płatną opcję aktywacji. Wyłączenie płatnego dostępu nie powoduje usunięcia opłaty za bieżący miesiąc.

   W przypadku Self-Hosted włącz dodatek w swojej organizacji Cloud, poczekaj, aż instalacja dokończy sprawdzanie licencji, a następnie włącz dostęp API w Ustawieniach instalacji. W tych przykładach użyj własnego adresu HTTPS instalacji zamiast adresu Cloud API.

2. Utwórz poświadczenie

   Utwórz dane uwierzytelniające API w Ustawieniach. Na potrzeby tego przewodnika zacznij od Zapasów. Jako zakres wybierz całą organizację lub jedną firmę. Zakresu nie można później zmienić; utwórz nowe poświadczenie, jeśli potrzebujesz innego zakresu.

3. Zachowaj sekret

   Dane uwierzytelniające API zawierają nazwę użytkownika i sekret. Sekret jest pokazywany tylko wtedy, gdy go utworzysz lub obrócisz. Zapisz go w menedżerze haseł lub magazynie sekretów. Można go używać ponownie do czasu jego odwołania lub wygaśnięcia; nie jest to jednorazowy kod weryfikacyjny ani hasło do logowania.

4. Złóż swoją pierwszą prośbę

   Uruchom przykład lokalnie. Monituje o podanie danych uwierzytelniających, uzyskuje token dostępu i wyświetla pierwszą stronę urządzeń. Zachowaj token jako prywatny. Te strony dokumentacji nigdy nie proszą o podanie danych uwierzytelniających ani ich nie przechowują.

   Wybierz język i zainstaluj zależności wymienione poniżej. W przykładach używany jest adres Cloud API. Nigdy nie wklejaj prawdziwych sekretów do dokumentacji, zgłoszeń do pomocy technicznej ani udostępnianych dzienników.

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

Uwierzytelnianie →

Uprawnienia i zakres

Predefiniowane ustawienia wybierają uprawnienia, a nie poziom dostępu. Ustawienia tworzą nowe dane uwierzytelniające z FullAccess; wybrane uprawnienia nadal ograniczają dostęp. Przed zapisaniem sprawdź niestandardowe uprawnienia. ReadOnly i ReadWrite opisują starsze lub oddzielnie utworzone dane uwierzytelniające, a nie nazwy predefiniowanych ustawień.

Organizacja, firma i obiekt

Organizacja to granica najwyższego poziomu Twojego konta. Firmy oddzielają w swoim obrębie klientów lub jednostki biznesowe. Witryny grupują urządzenia w obrębie firmy. Poświadczenia o zasięgu firmy nie mogą uzyskać dostępu do danych innej firmy.