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

Отправьте имя пользователя и секрет своих учетных данных в конечную точку токена. Для этого обмена не требуется токен на предъявителя. Используйте возвращенный токен доступа в качестве токена-носителя в последующих запросах REST.

password: Это поле JSON содержит секрет ваших учетных данных API, а не пароль для входа в учетную запись.

Сделайте свой первый запрос

Запустите пример локально. Он запрашивает ваши учетные данные, получает токен доступа и отображает первую страницу устройств. Держите токен в тайне. Эти страницы документации никогда не запрашивают и не хранят учетные данные.

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

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

Ответ токена доступа

Обмен учетными данными возвращает поля ниже. Показанный здесь токен является заполнителем. Срок действия указывается в секундах, а время истечения срока действия — в формате UTC.

{
  "accessToken": "<access-token>",
  "tokenType": "Bearer",
  "expiresIn": 1800,
  "expiresAtUtc": "2026-10-26T12:30:00Z"
}

Срок действия токенов, выданных с использованием учетных данных, составляет 30 минут. Этот обмен не возвращает токен обновления. Когда срок действия токена истечет, обмените учетные данные еще раз. В случае прерванной записи проверьте ее результат и правила повтора конечной точки, прежде чем повторять ее.

Выберите, где можно использовать токен доступа.

audience: "api"

Используйте это значение для запросов REST API. Это значение по умолчанию, если поле аудитории опущено.

audience: "mcp"

Используйте это значение только для клиента MCP, настроенного с использованием токена носителя. Для учетных данных должен быть включен MCP. Токены API и MCP не могут использоваться взаимозаменяемо.

Если аутентификация не удалась

401

Проверьте имя пользователя и секрет, срок действия учетных данных и их отзыв. По аутентифицированному запросу также проверьте срок действия токена и аудиторию. Повторение одних и тех же неверных учетных данных не решит проблему.

403

Проверьте код ответа и сообщение. Доступ может быть заблокирован разрешениями, политикой сети или страны, текущим доступом Владельца или правомочностью надстройки. Новый токен не обходит эти проверки.

429 · Retry-After

Прежде чем повторить попытку, дождитесь задержки, указанной в заголовке ответа. Ограничение попыток токена по умолчанию составляет 10 на IP-адрес источника в минуту на каждом реле. Настройки платформы могут изменить этот предел.

Справочник API → POST /v1/auth/token

Подключите ИИ-помощника →