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