RemoteGymp · API v1

認証

認証情報のユーザー名とシークレットをトークン エンドポイントに送信します。この交換には無記名トークンは必要ありません。返されたアクセス トークンを、後続の REST リクエストのベアラー トークンとして使用します。

password: この JSON フィールドには、アカウントのログイン パスワードではなく、API 認証情報のシークレットが含まれます。

最初のリクエストを行う

サンプルをローカルで実行します。資格情報の入力を求められ、アクセス トークンが取得され、デバイスの最初のページが一覧表示されます。トークンを非公開にしておきます。これらのドキュメント ページでは、資格情報を要求したり保存したりすることはありません。

言語を選択し、以下にリストされている依存関係をインストールします。例ではクラウド 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 ごとに 1 分あたり 10 です。プラットフォーム設定により、この制限を変更できます。

APIリファレンス → POST /v1/auth/token

AIアシスタントを接続する →

内容改訂3f225a253 · OpenAPI SHA-256: b12c42306a89