시작하기

액세스를 활성화하고 자격 증명을 생성한 후 첫 번째 API 요청을 합니다.

1. API 액세스 활성화

   조직 소유자는 설정에서 API 및 MCP 액세스를 활성화할 수 있습니다. 공유 추가 기능은 클라우드 및 연결된 자체 호스팅 설치의 경우 조직당 월 20달러입니다. 평가판 기간 동안 설정에서 API 및 MCP 액세스 포함 여부를 확인할 수 있습니다. '평가판에 포함됨'으로 표시되면 해당 위치에서 액세스를 활성화하고, 그렇지 않으면 유료 활성화 옵션을 검토하십시오. 유료 액세스를 비활성화해도 해당 월 요금은 면제되지 않습니다.

   셀프 호스팅의 경우 소유한 클라우드 조직에서 추가 기능을 활성화하고 설치가 라이선스 체크인을 완료하도록 한 다음 설치 설정에서 API 액세스를 활성화합니다. 이 예에서는 Cloud API 주소 대신 설치 자체 HTTPS 주소를 사용합니다.

2. 자격 증명 만들기

   설정에서 API 자격 증명을 생성합니다. 이 연습에서는 Inventory로만 시작하세요. 범위로 전체 조직 또는 한 회사를 선택합니다. 범위는 나중에 변경할 수 없습니다. 다른 범위가 필요한 경우 새 자격 증명을 만듭니다.

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는 사전 설정 이름이 아닌 이전 또는 별도로 생성된 자격 증명을 나타냅니다.

조직, 회사 및 현장

조직은 계정의 최상위 경계입니다. 회사는 고객이나 사업 단위를 분리합니다. 사이트는 회사 내의 장치를 그룹화합니다. 회사 범위 자격 증명은 다른 회사의 데이터에 액세스할 수 없습니다.