Inizia

Abilita l'accesso, crea una credenziale ed effettua la tua prima richiesta API.

1. Attiva l'accesso API

   Il proprietario dell'organizzazione abilita l'accesso a API e MCP nelle Impostazioni. Il componente aggiuntivo condiviso ha un costo di 20 dollari USA per organizzazione al mese per le installazioni Cloud e Self-Hosted collegate. Durante il periodo di prova, le Impostazioni mostrano se l'accesso a API e MCP è incluso. Se viene visualizzato "Incluso nel periodo di prova", abilitare l'accesso; altrimenti, valutare l'opzione di attivazione a pagamento. La disattivazione dell'accesso a pagamento non annulla l'addebito del mese corrente.

   Per Self-Hosted, abilita il componente aggiuntivo nella tua organizzazione Cloud di proprietà, lascia che l'installazione completi il ​​check-in della licenza, quindi abilita l'accesso API nelle Impostazioni dell'installazione. Utilizza l'indirizzo HTTPS dell'installazione anziché l'indirizzo API Cloud in questi esempi.

2. Crea una credenziale

   Crea una credenziale API in Impostazioni. Inizia con Inventario solo per questa procedura dettagliata. Scegli l'intera organizzazione o una società come ambito. L'ambito non può essere modificato successivamente; crea una nuova credenziale se hai bisogno di un ambito diverso.

3. Salva il segreto

   Una credenziale API ha un nome utente e un segreto. Il segreto viene mostrato solo quando lo crei o lo ruoti. Salvalo in un gestore di password o in un archivio segreto. È riutilizzabile fino a revoca o scadenza; non è un codice di verifica monouso o la tua password di accesso.

4. Fai la tua prima richiesta

   Eseguire l'esempio localmente. Richiede le credenziali, ottiene un token di accesso ed elenca la prima pagina dei dispositivi. Mantieni il token privato. Queste pagine di documentazione non richiedono né memorizzano mai le credenziali.

   Scegli una lingua e installa le dipendenze elencate di seguito. Gli esempi utilizzano l'indirizzo API Cloud. Non incollare mai veri segreti nella documentazione, nei ticket di supporto o nei registri condivisi.

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

Autenticazione →

Autorizzazioni e ambito di applicazione

Un preset seleziona le funzionalità, non il livello di accesso. Le impostazioni creano nuove credenziali con FullAccess; le funzionalità selezionate limitano comunque l'accesso. Rivedere le autorizzazioni personalizzate prima di salvare. ReadOnly e ReadWrite descrivono credenziali precedenti o create separatamente, non i nomi dei preset.

Organizzazione, azienda e sito

Un'organizzazione è il limite di livello superiore del tuo account. Le aziende separano i clienti o le unità aziendali al suo interno. I siti raggruppano i dispositivi all'interno di un'azienda. Una credenziale con ambito aziendale non può accedere ai dati di un'altra azienda.