Mulakan

Dayakan akses, buat bukti kelayakan dan buat permintaan API pertama anda.

1. Hidupkan akses API

   Pemilik Organisasi mendayakan akses API dan MCP dalam Tetapan. Alat tambah kongsi berharga US$20 setiap organisasi setiap bulan kalendar untuk pemasangan Awan dan Hos Kendiri yang dipautkan. Semasa percubaan, Tetapan menunjukkan sama ada akses API dan MCP disertakan. Jika ia menunjukkan Termasuk dalam percubaan, dayakan akses di sana; jika tidak, semak pilihan pengaktifan berbayar. Melumpuhkan akses berbayar tidak akan mengalih keluar caj bulan semasa.

   Untuk Dihoskan Sendiri, dayakan alat tambah dalam organisasi Awan milik anda, biarkan pemasangan menyelesaikan daftar masuk lesennya, kemudian dayakan akses API dalam Tetapan pemasangan. Gunakan alamat HTTPS pemasangan sendiri dan bukannya alamat Cloud API dalam contoh ini.

2. Buat kelayakan

   Cipta bukti kelayakan API dalam Tetapan. Mulakan dengan Inventori sahaja untuk panduan ini. Pilih keseluruhan organisasi atau satu syarikat sebagai skopnya. Skop tidak boleh diubah kemudian; buat bukti kelayakan baharu jika anda memerlukan skop yang berbeza.

3. Simpan rahsia

   Bukti kelayakan API mempunyai nama pengguna dan rahsia. Rahsia hanya ditunjukkan apabila anda mencipta atau memutarnya. Simpannya dalam pengurus kata laluan atau kedai rahsia. Ia boleh diguna semula sehingga dibatalkan atau tamat tempoh; ia bukan kod pengesahan sekali atau kata laluan log masuk anda.

4. Buat permintaan pertama anda

   Jalankan contoh secara tempatan. Ia meminta bukti kelayakan anda, mendapatkan token akses dan menyenaraikan halaman pertama peranti. Simpan token secara peribadi. Halaman dokumentasi ini tidak pernah meminta atau menyimpan bukti kelayakan.

   Pilih bahasa dan pasang kebergantungan yang disenaraikan di bawah. Contoh menggunakan alamat Cloud API. Jangan sekali-kali menampal rahsia sebenar ke dalam dokumentasi, tiket sokongan atau log kongsi.

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

Pengesahan →

Kebenaran dan skop

Pratetap memilih keupayaan, bukan tahap akses. Tetapan mencipta kelayakan baharu dengan FullAccess; keupayaan yang dipilih masih menyekat akses. Semak kebenaran tersuai sebelum menyimpan. ReadOnly dan ReadWrite menerangkan kelayakan yang lebih lama atau dibuat secara berasingan, bukan nama yang telah ditetapkan.

Organisasi, syarikat dan tapak

Organisasi ialah sempadan peringkat tertinggi akaun anda. Syarikat mengasingkan pelanggan atau unit perniagaan di dalamnya. Tapak kumpulan peranti dalam syarikat. Bukti kelayakan skop syarikat tidak boleh mengakses data syarikat lain.