RemoteGymp · API v1

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

Надішліть ім’я користувача та секрет своїх облікових даних кінцевій точці маркера. Ця біржа не потребує токена на пред’явника. Використовуйте повернутий маркер доступу як маркер-носій у наступних запитах REST.

password: Це поле JSON містить секрет облікових даних API, а не пароль для входу в обліковий запис.

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

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

Виберіть мову та встановіть наведені нижче залежності. У прикладах використовується адреса 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" }

Відповідь маркера доступу

Обмін обліковими даними повертає наведені нижче поля. Показаний тут маркер є заповнювачем. Термін дії вказується в секундах, а мітка часу закінчення – 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

Підключіть помічника AI →

Версія вмісту 3f225a253 · OpenAPI SHA-256: b12c42306a89