开始使用

启用访问、创建凭据并发出第一个 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 描述的是较早或单独创建的凭据，而非预设名称。

组织、公司和场所

组织是您帐户的顶级边界。公司将其内部的客户或业务部门分开。公司内的站点对设备进行分组。公司范围的凭据无法访问其他公司的数据。