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
等待响应标头中给出的延迟,然后再重试。每个中继上的默认令牌尝试限制为每个源 IP 每分钟 10 次。平台设置可以更改此限制。

API 参考 → POST /v1/auth/token

连接AI助手 →

内容修订3f225a253 · OpenAPI SHA-256: b12c42306a89