開始使用

啟用存取、建立憑證並發出第一個 API 請求。

1. 開啟API訪問

   組織擁有者可在「設定」中啟用 API 和 MCP 存取權限。共用附加元件的費用為每個組織每月 20 美元，適用於雲端和關聯的自架安裝。試用期間，「設定」會顯示是否包含 API 和 MCP 存取權限。如果顯示“包含在試用中”，請在試用中啟用存取權限；否則，請查看付費啟動選項。停用付費存取權限不會免除當月費用。

   對於自託管，在您擁有的雲端組織中啟用插件，讓安裝完成其許可證簽入，然後在安裝的設定中啟用 API 存取。在這些範例中，使用安裝自己的 HTTPS 位址而不是雲端 API 位址。

2. 建立憑證

   在「設定」中建立 API 憑證。本演練僅從庫存開始。選擇整個組織或一家公司作為其範圍。範圍以後不能更改；如果您需要不同的範圍，請建立新的憑證。

3. 保守秘密

   API 憑證具有使用者名稱和密碼。僅當您建立或輪換秘密時才會顯示該秘密。將其保存在密碼管理器或機密儲存中。它可以重複使用，直到被撤銷或過期；它不是一次性驗證碼或您的登入密碼。

4. 提出你的第一個請求

   在本地運行範例。它會提示您輸入憑證，取得存取權杖並列出裝置的第一頁。保持令牌的私密性。這些文件頁面從不要求或儲存憑證。

   選擇一種語言並安裝下面列出的依賴項。這些範例使用 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" }

認證 →

權限和範圍

預設選擇功能，而非存取等級。設定會使用 FullAccess 建立新憑證；所選功能仍會限制存取。儲存前請檢查自訂權限。 ReadOnly 和 ReadWrite 描述的是較早或單獨建立的憑證，而非預設名稱。

組織、公司和場所

組織是您帳戶的頂級邊界。本公司將其內部的客戶或業務部門分開。公司內的站點將設備分組。公司範圍的憑證無法存取其他公司的資料。