Magsimula

Paganahin ang pag-access, gumawa ng kredensyal at gawin ang iyong unang kahilingan sa API.

1. I-on ang access sa API

   Ang May-ari ng Organisasyon ay nagbibigay-daan sa pag-access sa API at MCP sa Mga Setting. Ang nakabahaging add-on ay nagkakahalaga ng US$20 bawat organisasyon bawat buwan sa kalendaryo para sa Cloud at mga naka-link na Self-Hosted na instalasyon. Sa panahon ng isang pagsubok, ipinapakita ng Mga Setting kung kasama ang access sa API at MCP. Kung ipinapakita nito ang Kasama sa pagsubok, paganahin ang access doon; kung hindi man ay suriin ang opsyon sa bayad na pag-activate. Ang hindi pagpapagana ng bayad na access ay hindi nag-aalis ng singil sa kasalukuyang buwan.

   Para sa Self-Hosted, paganahin ang add-on sa iyong pagmamay-ari na organisasyong Cloud, hayaang kumpletuhin ng pag-install ang pag-check-in ng lisensya nito, pagkatapos ay paganahin ang API access sa Mga Setting ng pag-install. Gamitin ang sariling HTTPS address ng pag-install sa halip na ang Cloud API address sa mga halimbawang ito.

2. Gumawa ng kredensyal

   Gumawa ng kredensyal ng API sa Mga Setting. Magsimula sa Imbentaryo para lang sa walkthrough na ito. Piliin ang buong organisasyon o isang kumpanya bilang saklaw nito. Hindi mababago ang saklaw sa ibang pagkakataon; gumawa ng bagong kredensyal kung kailangan mo ng ibang saklaw.

3. I-save ang sikreto

   Ang kredensyal ng API ay may username at lihim. Ang sikreto ay ipinapakita lamang kapag ginawa mo ito o pinaikot. I-save ito sa isang password manager o secret store. Ito ay magagamit muli hanggang sa bawiin o mag-expire; ito ay hindi isang beses na verification code o ang iyong login password.

4. Gawin ang iyong unang kahilingan

   Patakbuhin ang halimbawa nang lokal. Nag-prompt ito para sa iyong kredensyal, nakakakuha ng token ng pag-access at naglilista ng unang pahina ng mga device. Panatilihing pribado ang token. Ang mga pahina ng dokumentasyong ito ay hindi kailanman humihingi o nag-iimbak ng mga kredensyal.

   Pumili ng wika at i-install ang mga dependency na nakalista sa ibaba. Ginagamit ng mga halimbawa ang Cloud API address. Huwag kailanman i-paste ang mga totoong lihim sa dokumentasyon, mga tiket ng suporta o mga nakabahaging log.

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

Pagpapatunay →

Mga pahintulot at saklaw

Pumipili ng mga kakayahan ang isang preset, hindi ng antas ng access. Lumilikha ang mga setting ng mga bagong kredensyal gamit ang FullAccess; nililimitahan pa rin ng mga napiling kakayahan ang access. Suriin ang mga custom na pahintulot bago i-save. Inilalarawan ng ReadOnly at ReadWrite ang mga luma o hiwalay na nilikhang kredensyal, hindi ang mga preset na pangalan.

Organisasyon, kumpanya at site

Ang organisasyon ay ang pinakamataas na hangganan ng iyong account. Pinaghihiwalay ng mga kumpanya ang mga customer o unit ng negosyo sa loob nito. Ang mga site ay nagpapangkat ng mga device sa loob ng isang kumpanya. Hindi ma-access ng kredensyal na saklaw ng kumpanya ang data ng ibang kumpanya.