RemoteGymp · API v1

การยืนยันตัวตน

ส่งชื่อผู้ใช้และข้อมูลประจำตัวของคุณไปยังปลายทางโทเค็น การแลกเปลี่ยนนี้ไม่จำเป็นต้องมีโทเค็นผู้ถือ ใช้โทเค็นการเข้าถึงที่ส่งคืนเป็นโทเค็นผู้ถือในคำขอ REST ที่ตามมา

password: ฟิลด์ JSON นี้เก็บความลับข้อมูลรับรอง API ของคุณ ไม่ใช่รหัสผ่านสำหรับเข้าสู่ระบบบัญชีของคุณ

ทำคำขอแรกของคุณ

เรียกใช้ตัวอย่างภายในเครื่อง โดยจะแจ้งให้ระบุข้อมูลประจำตัวของคุณ รับโทเค็นการเข้าถึง และแสดงรายการหน้าแรกของอุปกรณ์ เก็บโทเค็นไว้เป็นส่วนตัว หน้าเอกสารเหล่านี้จะไม่ขอหรือจัดเก็บข้อมูลประจำตัว

เลือกภาษาและติดตั้งการอ้างอิงตามรายการด้านล่าง ตัวอย่างใช้ที่อยู่ Cloud API อย่าวางความลับที่แท้จริงลงในเอกสาร ตั๋วสนับสนุน หรือบันทึกที่แชร์

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

การตอบสนองโทเค็นการเข้าถึง

การแลกเปลี่ยนข้อมูลรับรองจะส่งคืนฟิลด์ด้านล่าง โทเค็นที่แสดงที่นี่คือตัวยึดตำแหน่ง อายุการใช้งานเป็นวินาทีและการประทับเวลาหมดอายุคือ UTC

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

โทเค็นที่ออกหนังสือรับรองมีอายุ 30 นาที การแลกเปลี่ยนนี้ไม่ส่งคืนโทเค็นการรีเฟรช เมื่อโทเค็นหมดอายุ ให้แลกเปลี่ยนข้อมูลรับรองอีกครั้ง สำหรับการเขียนที่ถูกขัดจังหวะ ให้ตรวจสอบผลลัพธ์และกฎการลองซ้ำของอุปกรณ์ปลายทางก่อนที่จะส่งอีกครั้ง

เลือกตำแหน่งที่สามารถใช้โทเค็นการเข้าถึงได้

audience: "api"
ใช้ค่านี้สำหรับคำขอ REST API เป็นค่าเริ่มต้นเมื่อละเว้นช่องผู้ชม
audience: "mcp"
ใช้ค่านี้สำหรับไคลเอนต์ MCP ที่กำหนดค่าด้วยโทเค็นผู้ถือเท่านั้น ข้อมูลรับรองต้องเปิดใช้งาน MCP โทเค็น API และ MCP ไม่สามารถใช้แทนกันได้

หากการรับรองความถูกต้องล้มเหลว

401
ตรวจสอบชื่อผู้ใช้และความลับ การหมดอายุและการเพิกถอนข้อมูลประจำตัว ในคำขอที่ได้รับการตรวจสอบสิทธิ์ ให้ตรวจสอบการหมดอายุของโทเค็นและผู้ชมด้วย การใช้ข้อมูลรับรองที่ไม่ถูกต้องซ้ำกันจะไม่สามารถแก้ไขปัญหาได้
403
ตรวจสอบรหัสตอบกลับและข้อความ การเข้าถึงอาจถูกบล็อกโดยสิทธิ์ นโยบายเครือข่ายหรือประเทศ การเข้าถึงปัจจุบันของเจ้าของ หรือสิทธิ์ของโปรแกรมเสริม โทเค็นใหม่จะไม่ข้ามการตรวจสอบเหล่านั้น
429 · Retry-After
รอความล่าช้าที่ระบุในส่วนหัวการตอบกลับก่อนลองอีกครั้ง ขีดจำกัดความพยายามโทเค็นเริ่มต้นคือ 10 ต่อ IP ต้นทางต่อนาทีในแต่ละรีเลย์ การตั้งค่าแพลตฟอร์มสามารถเปลี่ยนขีดจำกัดนี้ได้

การอ้างอิง API → POST /v1/auth/token

เชื่อมต่อผู้ช่วย AI →

3f225a253 แก้ไขเนื้อหา · OpenAPI SHA-256: b12c42306a89