Pengesahan

Hantar nama pengguna dan rahsia kelayakan anda ke titik akhir token. Pertukaran ini tidak memerlukan token pembawa. Gunakan token akses yang dikembalikan sebagai token pembawa pada permintaan REST berikutnya.

password: Medan JSON ini membawa rahsia kelayakan API anda, bukan kata laluan log masuk akaun anda.

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.

$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 kelayakan mengembalikan medan di bawah. Token yang ditunjukkan di sini ialah pemegang tempat. Jangka hayat adalah dalam saat dan cap masa tamat tempoh ialah UTC.

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

Token yang dikeluarkan bukti kelayakan bertahan selama 30 minit. Pertukaran ini tidak mengembalikan token muat semula. Apabila token tamat tempoh, tukar kelayakan semula. Untuk penulisan yang terganggu, semak keputusannya dan peraturan percubaan semula titik akhir sebelum menyerahkannya semula.

Pilih tempat token akses boleh digunakan

audience: "api"

Gunakan nilai ini untuk permintaan REST API. Ia adalah lalai apabila medan khalayak ditinggalkan.

audience: "mcp"

Gunakan nilai ini hanya untuk klien MCP yang dikonfigurasikan dengan token pembawa. Bukti kelayakan mesti didayakan MCP. Token API dan MCP tidak boleh digunakan secara bergantian.

Jika pengesahan gagal

401

Semak nama pengguna dan rahsia, tamat tempoh kelayakan dan pembatalan. Atas permintaan yang disahkan, semak juga tamat tempoh token dan khalayak. Mengulang bukti kelayakan tidak sah yang sama tidak akan menyelesaikan masalah.

403

Semak kod respons dan mesej. Akses mungkin disekat oleh kebenaran, dasar rangkaian atau negara, akses semasa Pemilik atau kelayakan tambahan. Token baharu tidak memintas cek tersebut.

429 · Retry-After

Tunggu kelewatan yang diberikan dalam tajuk respons sebelum mencuba lagi. Had percubaan token lalai ialah 10 setiap IP sumber seminit pada setiap Geganti. Tetapan platform boleh mengubah had ini.

Rujukan API → POST /v1/auth/token

Sambungkan pembantu AI →