Tantancewa

Aika sunan mai amfani da sirrin shaidarka zuwa ƙarshen alamar. Wannan musanya baya buƙatar alamar mai ɗaukar kaya. Yi amfani da alamar shiga da aka dawo a matsayin alamar mai ɗauka akan buƙatun REST masu zuwa.

password: Wannan filin JSON yana ɗauke da sirrin shaidar shaidar API ɗin ku, ba kalmar sirrin shiga asusun ku ba.

Yi buƙatarka ta farko

Gudanar da misali a gida. Yana haifar da shaidar shaidarka, yana samun alamar samun dama kuma yana jera shafin farko na na'urori. A kiyaye alamar ta sirri. Waɗannan shafuna na takaddun ba su taɓa yin tambaya ko adana takaddun shaida ba.

Zaɓi harshe kuma shigar da abubuwan dogaro da aka jera a ƙasa. Misalan suna amfani da adireshin Cloud API. Kar a taɓa liƙa ainihin sirrin cikin takardu, tikitin tallafi ko rajistan ayyukan da aka raba.

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

Amsa alamar shiga

Canjin takardar shaidar ya dawo da filayen da ke ƙasa. Alamar da aka nuna anan mai riƙewa ce. Tsawon rayuwa yana cikin daƙiƙa guda kuma tambarin lokacin ƙarewa shine UTC.

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

Alamomin da aka bayar na shaidar sun wuce mintuna 30. Wannan musanya baya dawo da alamar wartsakewa. Lokacin da alamar ta ƙare, sake musanya takardar shaidar. Don rubutun da aka katse, duba sakamakonsa da ka'idojin sake gwadawa na ƙarshen kafin sake ƙaddamar da shi.

Zaɓi inda za a iya amfani da alamar shiga

audience: "api"

Yi amfani da wannan ƙimar don buƙatun REST API. Tsohuwar ita ce lokacin da aka tsallake filin sauraro.

audience: "mcp"

Yi amfani da wannan ƙimar kawai don abokin ciniki na MCP wanda aka saita tare da alamar ɗauka. Dole ne a kunna takardar shaidar MCP. API da alamun MCP ba za a iya amfani da su ba.

Idan tantancewa ta gaza

401

Bincika sunan mai amfani da sirri, ƙarewar shaidar da sokewa. A kan ingantaccen buƙata, kuma duba alamar ƙarewar da masu sauraro. Maimaita wannan shaidar mara inganci ba zai gyara matsalar ba.

403

Duba lambar amsawa da saƙon. Ana iya toshe damar shiga ta izini, hanyar sadarwa ko manufofin ƙasa, damar mai shi na yanzu, ko cancantar ƙarawa. Sabuwar alamar ba ta ketare waɗannan cak ɗin.

429 · Retry-After

Jira jinkirin da aka bayar a cikin taken martani kafin sake gwadawa. Tsohuwar ƙayyadaddun ƙayyadaddun alama shine 10 kowane tushen IP a minti daya akan kowane Relay. Saitunan dandamali na iya canza wannan iyaka.

Ambaton API → POST /v1/auth/token

Haɗa mataimakin AI →