Начните работу

Включите доступ, создайте учетные данные и сделайте первый запрос API.

1. Включите доступ к API

   Владелец организации включает доступ к API и MCP в настройках. Стоимость общего дополнения составляет 20 долларов США на организацию в календарный месяц для облачных и связанных саморазмещенных установок. Во время пробного периода в настройках отображается информация о том, включен ли доступ к API и MCP. Если отображается «Включено в пробный период», включите доступ там; в противном случае ознакомьтесь с платным вариантом активации. Отключение платного доступа не отменяет плату за текущий месяц.

   Для самостоятельного размещения включите надстройку в своей облачной организации, дайте установке завершить регистрацию лицензии, а затем включите доступ через 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 описывают старые или отдельно созданные учетные данные, а не имена предустановок.

Организация, компания и площадка

Организация — это граница верхнего уровня вашей учетной записи. Компании разделяют клиентов или бизнес-единицы внутри себя. Сайты группируют устройства внутри компании. Учетные данные на уровне компании не могут получить доступ к данным другой компании.