Autentikasi — RemoteGymp

Kirimkan nama pengguna dan rahasia kredensial Anda ke titik akhir token. Pertukaran ini tidak memerlukan token pembawa. Gunakan token akses yang dikembalikan sebagai token pembawa pada permintaan REST berikutnya.

password: Bidang JSON ini berisi rahasia kredensial API Anda, bukan kata sandi masuk akun Anda.

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

Akses respons token

Pertukaran kredensial mengembalikan kolom di bawah ini. Token yang ditampilkan di sini adalah pengganti. Masa pakainya dalam hitungan detik dan stempel waktu kedaluwarsanya adalah UTC.

{
  "accessToken": "<access-token>",
  "tokenType": "Bearer",
  "expiresIn": 1800,
  "expiresAtUtc": "2026-10-26T12:30:00Z"
}

Token yang diterbitkan kredensial bertahan selama 30 menit. Pertukaran ini tidak mengembalikan token penyegaran. Saat token habis masa berlakunya, tukarkan kredensial lagi. Untuk penulisan yang terputus, periksa hasilnya dan aturan percobaan ulang titik akhir sebelum mengirimkannya kembali.

Pilih di mana token akses dapat digunakan

audience: "api": Gunakan nilai ini untuk permintaan REST API. Ini adalah default ketika bidang audiens dihilangkan.
audience: "mcp": Gunakan nilai ini hanya untuk klien MCP yang dikonfigurasi dengan token pembawa. Kredensial harus mengaktifkan MCP. Token API dan MCP tidak dapat digunakan secara bergantian.

Jika otentikasi gagal

401: Periksa nama pengguna dan rahasia, masa berlaku kredensial, dan pencabutan. Pada permintaan yang diautentikasi, periksa juga masa berlaku token dan audiensnya. Mengulangi kredensial tidak valid yang sama tidak akan menyelesaikan masalah.
403: Periksa kode respon dan pesan. Akses mungkin diblokir berdasarkan izin, kebijakan jaringan atau negara, akses Pemilik saat ini, atau kelayakan add-on. Token baru tidak melewati pemeriksaan tersebut.
429 · Retry-After: Tunggu penundaan yang diberikan di header respons sebelum mencoba lagi. Batas upaya token default adalah 10 per IP sumber per menit pada setiap Relai. Pengaturan platform dapat mengubah batas ini.

Referensi API → POST /v1/auth/token

Hubungkan asisten AI →