Memulai

Aktifkan akses, buat kredensial, dan buat permintaan API pertama Anda.

1. Aktifkan akses API

   Pemilik Organisasi mengaktifkan akses API dan MCP di Pengaturan. Add-on bersama ini berharga US$20 per organisasi per bulan kalender untuk instalasi Cloud dan Self-Hosted yang terhubung. Selama masa uji coba, Pengaturan menunjukkan apakah akses API dan MCP disertakan. Jika menunjukkan Termasuk dalam uji coba, aktifkan akses di sana; jika tidak, tinjau opsi aktivasi berbayar. Menonaktifkan akses berbayar tidak menghapus biaya bulan berjalan.

   Untuk Self-Hosted, aktifkan add-on di organisasi Cloud milik Anda, biarkan instalasi menyelesaikan check-in lisensinya, lalu aktifkan akses API di Pengaturan instalasi. Gunakan alamat HTTPS instalasi itu sendiri, bukan alamat Cloud API dalam contoh ini.

2. Buat kredensial

   Buat kredensial API di Pengaturan. Mulailah dengan Inventaris hanya untuk panduan ini. Pilih seluruh organisasi atau satu perusahaan sebagai ruang lingkupnya. Cakupan tidak dapat diubah nanti; buat kredensial baru jika Anda memerlukan cakupan yang berbeda.

3. Simpan rahasianya

   Kredensial API memiliki nama pengguna dan rahasia. Rahasianya hanya ditampilkan saat Anda membuat atau memutarnya. Simpan di pengelola kata sandi atau penyimpanan rahasia. Dapat digunakan kembali sampai dicabut atau habis masa berlakunya; ini bukan kode verifikasi satu kali atau kata sandi login Anda.

4. Buat permintaan pertama Anda

   Jalankan contoh secara lokal. Ini meminta kredensial Anda, memperoleh token akses dan mencantumkan halaman pertama perangkat. Jaga kerahasiaan token. Halaman dokumentasi ini tidak pernah meminta atau menyimpan kredensial.

   Pilih bahasa dan instal dependensi yang tercantum di bawah. Contohnya menggunakan alamat Cloud API. Jangan pernah menempelkan rahasia sebenarnya ke dalam dokumentasi, tiket dukungan, atau log bersama.

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

Autentikasi →

Izin dan ruang lingkup

Pengaturan memilih kemampuan, bukan tingkat akses. Pengaturan membuat kredensial baru dengan FullAccess; kemampuan yang dipilih masih membatasi akses. Tinjau izin khusus sebelum menyimpan. ReadOnly dan ReadWrite menjelaskan kredensial lama atau yang dibuat secara terpisah, bukan nama pengaturan.

Organisasi, perusahaan dan lokasi

Organisasi adalah batas tingkat atas akun Anda. Perusahaan memisahkan pelanggan atau unit bisnis di dalamnya. Situs mengelompokkan perangkat dalam suatu perusahaan. Kredensial cakupan perusahaan tidak dapat mengakses data perusahaan lain.