Kom igång

Aktivera åtkomst, skapa en autentiseringsinformation och gör din första API-förfrågan.

1. Aktivera API-åtkomst

   En organisationsägare aktiverar åtkomst till API och MCP i Inställningar. Det delade tillägget kostar 20 USD per organisation per kalendermånad för moln- och länkade självhostade installationer. Under en testperiod visar Inställningar om åtkomst till API och MCP ingår. Om det visas Ingår i testperioden, aktivera åtkomst där; annars granska alternativet för betalda aktiveringar. Att inaktivera betald åtkomst tar inte bort den aktuella månadens avgift.

   För Self-Hosted, aktivera tillägget i din ägande molnorganisation, låt installationen slutföra sin licensincheckning och aktivera sedan API-åtkomst i installationens inställningar. Använd installationens egen HTTPS-adress istället för Cloud API-adressen i dessa exempel.

2. Skapa autentiseringsuppgifter

   Skapa en API-uppgifter i Inställningar. Börja med endast inventering för den här genomgången. Välj hela organisationen eller ett företag som dess omfattning. Omfattning kan inte ändras senare; skapa en ny referens om du behöver en annan omfattning.

3. Spara hemligheten

   En API-referens har ett användarnamn och en hemlighet. Hemligheten visas bara när du skapar eller roterar den. Spara det i en lösenordshanterare eller hemlighetsbutik. Den är återanvändbar tills den återkallas eller löper ut; det är inte en engångsverifieringskod eller ditt inloggningslösenord.

4. Gör din första förfrågan

   Kör exemplet lokalt. Den frågar efter din referens, erhåller en åtkomsttoken och listar den första sidan med enheter. Håll token privat. Dessa dokumentationssidor ber aldrig om eller lagrar referenser.

   Välj ett språk och installera de beroenden som anges nedan. Exemplen använder Cloud API-adressen. Klistra aldrig in riktiga hemligheter i dokumentation, supportärenden eller delade loggar.

   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 →

Behörigheter och omfattning

En förinställning väljer funktioner, inte en åtkomstnivå. Inställningar skapar nya inloggningsuppgifter med FullAccess; de valda funktionerna begränsar fortfarande åtkomsten. Granska anpassade behörigheter innan du sparar. ReadOnly och ReadWrite beskriver äldre eller separat skapade inloggningsuppgifter, inte förinställda namn.

Organisation, företag och plats

En organisation är ditt kontos toppnivågräns. Företag separerar kunder eller affärsenheter inom det. Webbplatser grupperar enheter inom ett företag. En företagsomfattande autentiseringsinformation kan inte komma åt ett annat företags data.