Legen Sie los

Aktivieren Sie den Zugriff, erstellen Sie Anmeldeinformationen und stellen Sie Ihre erste API-Anfrage.

1. Aktivieren Sie den API-Zugriff

   Ein Organisationsinhaber aktiviert den Zugriff auf API und MCP in den Einstellungen. Das gemeinsame Add-on kostet 20 US-Dollar pro Organisation und Kalendermonat für Cloud- und verknüpfte Self-Hosting-Installationen. Während der Testphase wird in den Einstellungen angezeigt, ob der Zugriff auf API und MCP enthalten ist. Wenn „In der Testphase enthalten“ angezeigt wird, aktivieren Sie den Zugriff dort; andernfalls prüfen Sie die kostenpflichtige Aktivierungsoption. Die Deaktivierung des kostenpflichtigen Zugriffs entfernt nicht die Gebühr für den laufenden Monat.

   Aktivieren Sie für Self-Hosted das Add-on in Ihrer Cloud-Organisation, lassen Sie die Installation den Lizenz-Check-in abschließen und aktivieren Sie dann den API-Zugriff in den Einstellungen der Installation. Verwenden Sie in diesen Beispielen die eigene HTTPS-Adresse der Installation anstelle der Cloud-API-Adresse.

2. Erstellen Sie einen Berechtigungsnachweis

   Erstellen Sie in den Einstellungen eine API-Anmeldeinformation. Beginnen Sie für diese exemplarische Vorgehensweise nur mit der Bestandsaufnahme. Wählen Sie als Geltungsbereich die gesamte Organisation oder ein einzelnes Unternehmen. Der Geltungsbereich kann nachträglich nicht mehr geändert werden; Erstellen Sie einen neuen Berechtigungsnachweis, wenn Sie einen anderen Bereich benötigen.

3. Bewahren Sie das Geheimnis

   Eine API-Anmeldeinformation besteht aus einem Benutzernamen und einem Geheimnis. Das Geheimnis wird nur angezeigt, wenn Sie es erstellen oder drehen. Speichern Sie es in einem Passwort-Manager oder Geheimspeicher. Es ist wiederverwendbar, bis es widerrufen wird oder abläuft. Es handelt sich nicht um einen einmaligen Bestätigungscode oder Ihr Login-Passwort.

4. Stellen Sie Ihre erste Anfrage

   Führen Sie das Beispiel lokal aus. Es fordert Sie zur Eingabe Ihrer Anmeldedaten auf, ruft ein Zugriffstoken ab und listet die erste Seite der Geräte auf. Halten Sie den Token privat. Auf diesen Dokumentationsseiten werden niemals Anmeldeinformationen abgefragt oder gespeichert.

   Wählen Sie eine Sprache und installieren Sie die unten aufgeführten Abhängigkeiten. Die Beispiele verwenden die Cloud-API-Adresse. Fügen Sie niemals echte Geheimnisse in Dokumentationen, Support-Tickets oder freigegebene Protokolle ein.

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

Authentifizierung →

Berechtigungen und Geltungsbereich

Eine Voreinstellung wählt Funktionen aus, keine Zugriffsebene. Einstellungen erstellt neue Anmeldeinformationen mit FullAccess; Die ausgewählten Funktionen schränken den Zugriff weiterhin ein. Überprüfen Sie die benutzerdefinierten Berechtigungen vor dem Speichern. ReadOnly und ReadWrite beschreiben ältere oder separat erstellte Anmeldeinformationen, keine voreingestellten Namen.

Organisation, Unternehmen und Standort

Eine Organisation ist die oberste Ebene Ihres Kontos. Unternehmen trennen darin Kunden oder Geschäftseinheiten. Sites gruppieren Geräte innerhalb eines Unternehmens. Ein unternehmensbezogener Berechtigungsnachweis kann nicht auf die Daten eines anderen Unternehmens zugreifen.