Ga aan de slag

Schakel toegang in, maak een inloggegevens aan en dien uw eerste API-verzoek in.

1. Schakel API-toegang in

   Een organisatie-eigenaar kan de toegang tot API en MCP inschakelen in de instellingen. De gedeelde add-on kost US$ 20 per organisatie per kalendermaand voor cloud- en gekoppelde zelfgehoste installaties. Tijdens een proefperiode wordt in de instellingen weergegeven of de toegang tot API en MCP is inbegrepen. Als er 'Inbegrepen in proefperiode' staat, kunt u de toegang daar inschakelen; anders kunt u de optie voor betaalde activering bekijken. Het uitschakelen van betaalde toegang heft de kosten voor de huidige maand niet op.

   Voor Self-Hosted schakelt u de add-on in uw eigen Cloud-organisatie in, laat de installatie het inchecken van de licentie voltooien en schakelt u vervolgens API-toegang in de instellingen van de installatie in. Gebruik in deze voorbeelden het eigen HTTPS-adres van de installatie in plaats van het Cloud API-adres.

2. Maak een referentie aan

   Maak een API-referentie aan in Instellingen. Begin alleen met Voorraad voor deze walkthrough. Kies de hele organisatie of één bedrijf als scope. De reikwijdte kan later niet worden gewijzigd; maak een nieuwe referentie als u een ander bereik nodig heeft.

3. Bewaar het geheim

   Een API-referentie heeft een gebruikersnaam en een geheim. Het geheim wordt alleen weergegeven wanneer u het maakt of roteert. Bewaar het in een wachtwoordbeheerder of geheimenarchief. Het is herbruikbaar totdat het wordt ingetrokken of verlopen; het is geen eenmalige verificatiecode of uw inlogwachtwoord.

4. Doe uw eerste verzoek

   Voer het voorbeeld lokaal uit. Het vraagt ​​om uw inloggegevens, verkrijgt een toegangstoken en vermeldt de eerste pagina met apparaten. Houd het token privé. Deze documentatiepagina's vragen nooit om inloggegevens en slaan deze ook niet op.

   Kies een taal en installeer de onderstaande afhankelijkheden. In de voorbeelden wordt het Cloud API-adres gebruikt. Plak nooit echte geheimen in documentatie, supporttickets of gedeelde logboeken.

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

Authenticatie →

Machtigingen en reikwijdte

Een voorinstelling selecteert mogelijkheden, niet een toegangsniveau. Instellingen maakt nieuwe referenties aan met FullAccess; de geselecteerde mogelijkheden beperken nog steeds de toegang. Controleer aangepaste machtigingen voordat u opslaat. ReadOnly en ReadWrite beschrijven oudere of afzonderlijk aangemaakte referenties, niet de namen van voorinstellingen.

Organisatie, bedrijf en locatie

Een organisatie is de hoogste grens van uw account. Bedrijven scheiden daarbinnen klanten of bedrijfseenheden. Sites groeperen apparaten binnen een bedrijf. Een bedrijfsreferentie heeft geen toegang tot de gegevens van een ander bedrijf.