始めましょう

アクセスを有効にし、認証情報を作成して、最初の API リクエストを作成します。

1. API アクセスをオンにする

   組織オーナーは、設定でAPIとMCPへのアクセスを有効にします。この共有アドオンは、クラウドおよびリンクされたセルフホスト型インストールの場合、組織あたり月額20米ドルです。トライアル期間中は、設定でAPIとMCPへのアクセスが含まれているかどうかが表示されます。トライアルに含まれている場合は、そこでアクセスを有効にしてください。含まれていない場合は、有料アクティベーションオプションを確認してください。有料アクセスを無効にしても、当月の料金は免除されません。

   セルフホストの場合、所有するクラウド組織でアドオンを有効にし、インストールでライセンスのチェックインを完了させてから、インストールの設定で API アクセスを有効にします。これらの例では、Cloud API アドレスの代わりに、インストール独自の HTTPS アドレスを使用します。

2. 認証情報を作成する

   [設定] で API 認証情報を作成します。このウォークスルーでは、インベントリのみから開始します。範囲として組織全体または 1 つの会社を選択します。スコープは後で変更できません。別のスコープが必要な場合は、新しい認証情報を作成します。

3. シークレットを保存する

   API 認証情報にはユーザー名とシークレットが含まれます。シークレットは、作成または回転する場合にのみ表示されます。パスワード マネージャーまたはシークレット ストアに保存します。取り消されるか期限が切れるまで再利用できます。これはワンタイム認証コードやログインパスワードではありません。

4. 最初のリクエストを行う

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

   言語を選択し、以下にリストされている依存関係をインストールします。例ではクラウド 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" }

認証 →

権限と範囲

プリセットはアクセスレベルではなく、機能を選択します。設定では、FullAccessを使用して新しい認証情報が作成されますが、選択された機能によってアクセスが制限されます。保存する前に、カスタム権限を確認してください。ReadOnlyとReadWriteは、プリセット名ではなく、以前または別途作成された認証情報を示します。

組織、会社およびサイト

組織はアカウントの最上位の境界です。企業は顧客や社内の事業単位を分離します。サイトは企業内のデバイスをグループ化します。企業スコープの資格情報は、別の企業のデータにアクセスできません。