Почніть роботу

Увімкніть доступ, створіть облікові дані та зробіть свій перший запит API.

1. Увімкніть доступ через API

   Власник організації надає доступ до API та MCP у налаштуваннях. Спільне доповнення коштує 20 доларів США на організацію за календарний місяць для хмарних та пов’язаних самостійно розміщених інсталяцій. Під час пробного періоду в налаштуваннях відображається, чи включено доступ до API та MCP. Якщо відображається «Включено в пробний період», увімкніть доступ там; в іншому випадку перегляньте опцію платної активації. Вимкнення платного доступу не скасовує плату за поточний місяць.

   Для Self-Hosted увімкніть надбудову у вашій хмарній організації, дозвольте інсталяції завершити перевірку ліцензії, а потім увімкніть доступ через API у налаштуваннях інсталяції. У цих прикладах використовуйте власну HTTPS-адресу установки замість адреси Cloud API.

2. Створіть облікові дані

   Створіть облікові дані API в налаштуваннях. Почніть із інвентарю лише для цього покрокового керівництва. Виберіть всю організацію або одну компанію як її сферу. Область не можна змінити пізніше; створіть нові облікові дані, якщо вам потрібен інший обсяг.

3. Збережи секрет

   Облікові дані API мають ім’я користувача та секрет. Секрет відображається лише тоді, коли ви його створюєте або обертаєте. Збережіть його в менеджері паролів або секретному сховищі. Його можна використовувати багаторазово, доки його не буде відкликано або термін дії не закінчиться; це не одноразовий код підтвердження або ваш пароль для входу.

4. Зробіть свій перший запит

   Запустіть приклад локально. Він запитує ваші облікові дані, отримує маркер доступу та відображає першу сторінку пристроїв. Зберігайте маркер приватним. Ці сторінки документації ніколи не запитують і не зберігають облікові дані.

   Виберіть мову та встановіть наведені нижче залежності. У прикладах використовується адреса Cloud API. Ніколи не вставляйте справжні секрети в документацію, запити служби підтримки чи спільні журнали.

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

Аутентифікація →

Дозволи та область

Попередній налаштування вибирає можливості, а не рівень доступу. Параметри «Налаштування» створюють нові облікові дані за допомогою FullAccess; вибрані можливості все ще обмежують доступ. Перегляньте користувацькі дозволи перед збереженням. ReadOnly та ReadWrite описують старіші або окремо створені облікові дані, а не назви попередніх налаштувань.

Організація, компанія та сайт

Організація є межею верхнього рівня вашого облікового запису. Компанії відокремлюють клієнтів або бізнес-одиниці всередині себе. Сайти групують пристрої в межах компанії. Облікові дані компанії не можуть отримати доступ до даних іншої компанії.