RemoteGymp · API v1

Dilysiad

Anfonwch eich enw defnyddiwr a'ch cyfrinach i'r pwynt terfyn tocyn. Nid oes angen tocyn cludwr ar y cyfnewid hwn. Defnyddiwch y tocyn mynediad a ddychwelwyd fel tocyn cludwr ar geisiadau REST dilynol.

password: Mae'r maes JSON hwn yn cynnwys eich cyfrinach credential API, nid eich cyfrinair mewngofnodi cyfrif.

Gwnewch eich cais cyntaf

Rhedeg yr enghraifft yn lleol. Mae'n annog eich tystlythyr, yn cael tocyn mynediad ac yn rhestru tudalen gyntaf dyfeisiau. Cadwch y tocyn yn breifat. Nid yw'r tudalennau dogfennaeth hyn byth yn gofyn am nac yn storio tystlythyrau.

Dewiswch iaith a gosodwch y dibyniaethau a restrir isod. Mae'r enghreifftiau'n defnyddio'r cyfeiriad Cloud API. Peidiwch byth â gludo cyfrinachau go iawn i ddogfennaeth, tocynnau cymorth neu logiau a rennir.

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

Ymateb tocyn mynediad

Mae'r cyfnewid credential yn dychwelyd y meysydd isod. Dalfan yw'r tocyn a ddangosir yma. Mae'r oes mewn eiliadau a'r stamp amser dod i ben yw UTC.

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

Mae tocynnau tysteb yn para 30 munud. Nid yw'r cyfnewid hwn yn dychwelyd tocyn adnewyddu. Pan ddaw tocyn i ben, cyfnewidiwch y tystlythyr eto. Ar gyfer ysgrifennu amharir, gwiriwch ei ganlyniad a rheolau ailgynnig y pwynt terfyn cyn ei ailgyflwyno.

Dewiswch ble y gellir defnyddio'r tocyn mynediad

audience: "api"
Defnyddiwch y gwerth hwn ar gyfer ceisiadau REST API. Dyma'r rhagosodiad pan gaiff maes y gynulleidfa ei hepgor.
audience: "mcp"
Defnyddiwch y gwerth hwn yn unig ar gyfer cleient MCP sydd wedi'i ffurfweddu â thocyn cludwr. Rhaid i'r cymhwyster MCP alluogi. Ni ellir defnyddio tocynnau API a MCP yn gyfnewidiol.

Os bydd dilysu yn methu

401
Gwiriwch yr enw defnyddiwr a chyfrinach, dod i ben credential a dirymu. Ar gais wedi'i ddilysu, gwiriwch hefyd bod tocyn wedi dod i ben a'r gynulleidfa. Ni fydd ailadrodd yr un manylion annilys yn datrys y broblem.
403
Gwiriwch y cod ymateb a'r neges. Gall mynediad gael ei rwystro gan ganiatadau, polisi rhwydwaith neu wlad, mynediad cyfredol y Perchennog, neu gymhwysedd ychwanegiad. Nid yw tocyn newydd yn osgoi'r gwiriadau hynny.
429 · Retry-After
Arhoswch am yr oedi a roddir ym mhennyn yr ymateb cyn ceisio eto. Y terfyn ymgais diofyn tocyn yw 10 y ffynhonnell IP y funud ar bob Ras Gyfnewid. Gall gosodiadau platfform newid y terfyn hwn.

Cyfeirnod API → POST /v1/auth/token

Cysylltwch gynorthwyydd AI →

Adolygiad cynnwys 3f225a253 · OpenAPI SHA-256: b12c42306a89