Kom i gang

Aktiver adgang, opret en legitimationsoplysninger og lav din første API-anmodning.

1. Slå API-adgang til

   En organisationsejer aktiverer API- og MCP-adgang i Indstillinger. Det delte tilføjelsesprogram koster 20 USD pr. organisation pr. kalendermåned for cloud- og linkede selvhostede installationer. Under en prøveperiode viser Indstillinger, om API- og MCP-adgang er inkluderet. Hvis det vises Inkluderet i prøveperiode, skal du aktivere adgang der; ellers gennemgå den betalte aktiveringsmulighed. Deaktivering af betalt adgang fjerner ikke den aktuelle måneds opkrævning.

   For Self-Hosted skal du aktivere tilføjelsen i din ejer Cloud-organisation, lade installationen fuldføre licensindtjekningen, og derefter aktivere API-adgang i installationens Indstillinger. Brug installationens egen HTTPS-adresse i stedet for Cloud API-adressen i disse eksempler.

2. Opret en legitimationsoplysninger

   Opret en API-legitimationsoplysninger i Indstillinger. Start kun med inventar for denne gennemgang. Vælg hele organisationen eller én virksomhed som dens omfang. Omfang kan ikke ændres senere; oprette en ny legitimation, hvis du har brug for et andet omfang.

3. Gem hemmeligheden

   En API-legitimationsoplysninger har et brugernavn og en hemmelighed. Hemmeligheden vises kun, når du opretter eller roterer den. Gem det i en adgangskodeadministrator eller hemmelighedsbutik. Det kan genbruges, indtil det tilbagekaldes eller udløber; det er ikke en engangsbekræftelseskode eller dit login-adgangskode.

4. Lav din første anmodning

   Kør eksemplet lokalt. Den beder om dine legitimationsoplysninger, får et adgangstoken og viser den første side med enheder. Hold tokenet privat. Disse dokumentationssider beder aldrig om eller gemmer aldrig legitimationsoplysninger.

   Vælg et sprog og installer de afhængigheder, der er angivet nedenfor. Eksemplerne bruger Cloud API-adressen. Indsæt aldrig rigtige hemmeligheder i dokumentation, supportbilletter eller delte logfiler.

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

Godkendelse →

Tilladelser og omfang

En forudindstilling vælger funktioner, ikke et adgangsniveau. Indstillinger opretter nye legitimationsoplysninger med FullAccess; de valgte funktioner begrænser stadig adgang. Gennemgå brugerdefinerede tilladelser, før du gemmer. ReadOnly og ReadWrite beskriver ældre eller separat oprettede legitimationsoplysninger, ikke forudindstillede navne.

Organisation, virksomhed og site

En organisation er din kontos grænse på øverste niveau. Virksomheder adskiller kunder eller forretningsenheder inden for det. Websteder grupperer enheder i en virksomhed. En virksomhedsdækket legitimationsoplysninger kan ikke få adgang til en anden virksomheds data.