Kom i gang

Aktiver tilgang, opprett en legitimasjon og foreta din første API-forespørsel.

1. Slå på API-tilgang

   En organisasjonseier aktiverer API- og MCP-tilgang i Innstillinger. Det delte tillegget koster 20 USD per organisasjon per kalendermåned for skybaserte og koblede selvhostede installasjoner. Under en prøveperiode viser Innstillinger om API- og MCP-tilgang er inkludert. Hvis det vises Inkludert i prøveperiode, aktiver tilgang der; ellers se gjennom det betalte aktiveringsalternativet. Deaktivering av betalt tilgang fjerner ikke gjeldende måneds belastning.

   For Self-Hosted aktiverer du tillegget i din egen Cloud-organisasjon, lar installasjonen fullføre lisensinnsjekkingen, og aktiver deretter API-tilgang i installasjonens innstillinger. Bruk installasjonens egen HTTPS-adresse i stedet for Cloud API-adressen i disse eksemplene.

2. Opprett en legitimasjon

   Opprett en API-legitimasjon i Innstillinger. Start med inventar kun for denne gjennomgangen. Velg hele organisasjonen eller ett selskap som omfang. Omfang kan ikke endres senere; opprette en ny legitimasjon hvis du trenger et annet omfang.

3. Lagre hemmeligheten

   En API-legitimasjon har et brukernavn og en hemmelighet. Hemmeligheten vises bare når du oppretter eller roterer den. Lagre det i en passordbehandler eller hemmelighetsbutikk. Det er gjenbrukbart til det oppheves eller utløper; det er ikke en engangsbekreftelseskode eller påloggingspassordet ditt.

4. Lag din første forespørsel

   Kjør eksemplet lokalt. Den ber om legitimasjonen din, får et tilgangstoken og viser den første siden med enheter. Hold tokenet privat. Disse dokumentasjonssidene ber aldri om eller lagrer legitimasjon.

   Velg et språk og installer avhengighetene som er oppført nedenfor. Eksemplene bruker Cloud API-adressen. Lim aldri inn ekte hemmeligheter i dokumentasjon, støttebilletter eller delte logger.

   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" }

Autentisering →

Tillatelser og omfang

En forhåndsinnstilling velger funksjoner, ikke et tilgangsnivå. Innstillinger oppretter ny legitimasjon med FullAccess; de valgte funksjonene begrenser fortsatt tilgang. Se gjennom tilpassede tillatelser før du lagrer. ReadOnly og ReadWrite beskriver eldre eller separat opprettet legitimasjon, ikke forhåndsinnstilte navn.

Organisasjon, selskap og sted

En organisasjon er kontoens toppnivågrense. Selskaper skiller kunder eller forretningsenheter innenfor den. Nettsteder grupperer enheter i et selskap. En selskapsomfanget legitimasjon kan ikke få tilgang til et annet selskaps data.