Începeți

Activați accesul, creați o autentificare și faceți prima cerere API.

1. Activați accesul API

   Un proprietar de organizație activează accesul la API și MCP în Setări. Add-on-ul partajat costă 20 USD per organizație pe lună calendaristică pentru instalările în cloud și cele auto-găzduite conectate. În timpul unei perioade de probă, Setările arată dacă accesul la API și MCP este inclus. Dacă se afișează „Inclus în perioada de probă”, activați accesul acolo; în caz contrar, verificați opțiunea de activare plătită. Dezactivarea accesului plătit nu elimină taxa lunară curentă.

   Pentru Self-Gazduit, activați suplimentul în organizația dvs. Cloud deținută, lăsați instalarea să își finalizeze înregistrarea licenței, apoi activați accesul API în Setările instalării. Utilizați adresa HTTPS proprie a instalării în loc de adresa API-ului Cloud în aceste exemple.

2. Creați o acreditare

   Creați o autentificare API în Setări. Începeți cu Inventar numai pentru acest tutorial. Alegeți întreaga organizație sau o companie ca scop. Domeniul de aplicare nu poate fi modificat ulterior; creați o nouă acreditare dacă aveți nevoie de un domeniu diferit.

3. Salvează secretul

   O acreditare API are un nume de utilizator și un secret. Secretul este afișat numai atunci când îl creați sau îl rotiți. Salvați-l într-un manager de parole sau într-un magazin de secrete. Este reutilizabil până la revocare sau expirare; nu este un cod de verificare unic sau parola de conectare.

4. Fă prima ta cerere

   Rulați exemplul local. Acesta vă solicită acreditările, obține un token de acces și listează prima pagină a dispozitivelor. Păstrați tokenul privat. Aceste pagini de documentație nu solicită și nu stochează niciodată acreditări.

   Alegeți o limbă și instalați dependențele enumerate mai jos. Exemplele folosesc adresa Cloud API. Nu lipiți niciodată secrete reale în documentație, bilete de asistență sau jurnalele partajate.

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

Autentificare →

Permisiuni și domeniul de aplicare

O presetare selectează capacități, nu un nivel de acces. Setările creează noi acreditări cu FullAccess; capacitățile selectate restricționează în continuare accesul. Verificați permisiunile personalizate înainte de salvare. ReadOnly și ReadWrite descriu acreditări mai vechi sau create separat, nu nume de presetări.

Organizație, companie și locație

O organizație este limita de nivel superior a contului dvs. Companiile separă clienții sau unitățile de afaceri în cadrul acesteia. Site-urile grupează dispozitive în cadrul unei companii. O acreditare aferentă companiei nu poate accesa datele altei companii.