Cychwyn arni

Galluogi mynediad, creu credential a gwneud eich cais API cyntaf.

1. Trowch ar API mynediad

   Mae Perchennog Sefydliad yn galluogi mynediad API a MCP yn y Gosodiadau. Mae'r ychwanegiad a rennir yn costio US$20 fesul sefydliad fesul mis calendr ar gyfer gosodiadau Cwmwl a Hunan-Gynnal cysylltiedig. Yn ystod treial, mae Gosodiadau'n dangos a yw mynediad API a MCP wedi'i gynnwys. Os yw'n dangos Wedi'i gynnwys yn y treial, galluogwch fynediad yno; fel arall adolygwch yr opsiwn actifadu taledig. Nid yw analluogi mynediad taledig yn dileu tâl y mis cyfredol.

   Ar gyfer Self-Hosted, galluogwch yr ychwanegiad yn eich sefydliad Cloud eich hun, gadewch i'r gosodiad gwblhau ei gofrestru trwydded, yna galluogi mynediad API yng Ngosodiadau'r gosodiad. Defnyddiwch gyfeiriad HTTPS y gosodiad ei hun yn lle'r cyfeiriad Cloud API yn yr enghreifftiau hyn.

2. Creu credential

   Creu cymhwyster API mewn Gosodiadau. Dechreuwch gyda'r Rhestr yn unig ar gyfer y llwybr cerdded hwn. Dewiswch y sefydliad cyfan neu un cwmni fel ei gwmpas. Ni ellir newid cwmpas yn ddiweddarach; creu cymhwyster newydd os oes angen cwmpas gwahanol arnoch.

3. Achub y gyfrinach

   Mae gan gymhwyster API enw defnyddiwr a chyfrinach. Dim ond pan fyddwch chi'n ei greu neu'n ei gylchdroi y dangosir y gyfrinach. Cadwch ef mewn rheolwr cyfrinair neu storfa gyfrinachau. Gellir ei hailddefnyddio nes iddo gael ei dirymu neu nes iddo ddod i ben; nid yw'n god dilysu un-amser nac yn eich cyfrinair mewngofnodi.

4. Gwnewch eich cais cyntaf

   Rhedeg yr enghraifft yn lleol. Mae'n annog eich tystlythyr, yn cael tocyn mynediad ac yn rhestru tudalen gyntaf dyfeisiau. Cadwch y tocyn yn breifat. Nid yw'r tudalennau dogfennaeth hyn byth yn gofyn am nac yn storio tystlythyrau.

   Dewiswch iaith a gosodwch y dibyniaethau a restrir isod. Mae'r enghreifftiau'n defnyddio'r cyfeiriad Cloud API. Peidiwch byth â gludo cyfrinachau go iawn i ddogfennaeth, tocynnau cymorth neu logiau a rennir.

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

Dilysiad →

Caniatâd a chwmpas

Mae rhagosodiad yn dewis galluoedd, nid lefel mynediad. Mae gosodiadau'n creu manylion mewngofnodi newydd gyda FullAccess; mae'r galluoedd a ddewiswyd yn dal i gyfyngu ar fynediad. Adolygwch ganiatadau personol cyn arbed. Mae ReadOnly a ReadWrite yn disgrifio manylion mewngofnodi hŷn neu rai a grëwyd ar wahân, nid enwau rhagosodiadau.

Sefydliad, cwmni a safle

Sefydliad yw ffin lefel uchaf eich cyfrif. Mae cwmnïau'n gwahanu cwsmeriaid neu unedau busnes oddi mewn iddo. Mae safleoedd yn grwpio dyfeisiau o fewn cwmni. Ni all manylion adnabod cwmni gael mynediad at ddata cwmni arall.