Aloita

Salli käyttöoikeus, luo tunnistetiedot ja tee ensimmäinen API-pyyntösi.

1. Ota API-käyttö käyttöön

   Organisaation omistaja ottaa käyttöön API- ja MCP-käyttöoikeudet asetuksissa. Jaettu lisäosa maksaa 20 Yhdysvaltain dollaria organisaatiota kohden kalenterikuukaudessa pilvi- ja linkitetyissä itse isännöidyissä asennuksissa. Kokeilujakson aikana asetuksissa näkyy, sisältyykö API- ja MCP-käyttöoikeudet. Jos kohdassa lukee Sisältyy kokeiluun, ota käyttöoikeudet käyttöön siellä; muussa tapauksessa tarkista maksullinen aktivointivaihtoehto. Maksullisen käyttöoikeuden poistaminen käytöstä ei poista kuluvan kuukauden maksua.

   Jos kyseessä on Self-Hosted, ota lisäosa käyttöön omistamassasi pilviorganisaatiossa, anna asennuksen suorittaa lisenssin sisäänkirjautuminen ja ota sitten API-käyttö käyttöön asennuksen asetuksista. Käytä näissä esimerkeissä asennuksen omaa HTTPS-osoitetta Cloud API -osoitteen sijaan.

2. Luo valtakirja

   Luo API-tunnistetiedot asetuksissa. Aloita vain tämän esittelyn Inventory-toiminnolla. Valitse laajuudeksi koko organisaatio tai yksi yritys. Laajuutta ei voi muuttaa myöhemmin; luo uusi valtuustieto, jos tarvitset eri laajuuden.

3. Tallenna salaisuus

   API-tunnistetiedoissa on käyttäjänimi ja salaisuus. Salaisuus näytetään vain, kun luot tai kierrät sitä. Tallenna se salasanan hallintaan tai salaisuuksiin. Sitä voidaan käyttää uudelleen, kunnes se peruutetaan tai vanhenee; se ei ole kertaluonteinen vahvistuskoodi tai kirjautumissalasanasi.

4. Tee ensimmäinen pyyntösi

   Suorita esimerkki paikallisesti. Se pyytää valtuustietojasi, hankkii pääsytunnuksen ja luetteloi laitteiden ensimmäisen sivun. Pidä tunnus yksityisenä. Näillä dokumentaatiosivuilla ei koskaan kysytä tai tallenneta valtuustietoja.

   Valitse kieli ja asenna alla luetellut riippuvuudet. Esimerkeissä käytetään Cloud API -osoitetta. Älä koskaan liitä oikeita salaisuuksia dokumentaatioon, tukilippuihin tai jaettuihin lokeihin.

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

Todennus →

Luvat ja laajuus

Esiasetus valitsee ominaisuudet, ei käyttöoikeustasoa. Asetukset luovat uudet tunnistetiedot FullAccess:lla; valitut ominaisuudet rajoittavat edelleen käyttöoikeuksia. Tarkista mukautetut käyttöoikeudet ennen tallentamista. ReadOnly ja ReadWrite kuvaavat vanhempia tai erikseen luotuja tunnistetietoja, eivät esiasetettuja nimiä.

Organisaatio, yritys ja toimipaikka

Organisaatio on tilisi ylätason raja. Yritykset erilliset asiakkaat tai liiketoimintayksiköt sen sisällä. Sivustot ryhmittelevät laitteet yrityksen sisällä. Yrityksen kattavilla valtuustiedoilla ei ole pääsyä toisen yrityksen tietoihin.