RemoteGymp · API v1

เริ่มต้นใช้งาน

เปิดใช้งานการเข้าถึง สร้างข้อมูลรับรอง และสร้างคำขอ API แรกของคุณ

  1. เปิดการเข้าถึง API

    เจ้าขององค์กรสามารถเปิดใช้งานการเข้าถึง API และ MCP ในการตั้งค่าได้ ส่วนเสริมที่ใช้ร่วมกันมีค่าใช้จ่าย 20 ดอลลาร์สหรัฐต่อองค์กรต่อเดือนสำหรับระบบคลาวด์และการติดตั้งแบบ Self-Hosted ที่เชื่อมโยง ในระหว่างช่วงทดลองใช้ การตั้งค่าจะแสดงว่าการเข้าถึง API และ MCP รวมอยู่ด้วยหรือไม่ หากแสดงว่ารวมอยู่ในการทดลองใช้ ให้เปิดใช้งานการเข้าถึงที่นั่น มิฉะนั้นให้ตรวจสอบตัวเลือกการเปิดใช้งานแบบชำระเงิน การปิดใช้งานการเข้าถึงแบบชำระเงินจะไม่ลบค่าใช้จ่ายของเดือนปัจจุบัน

    สำหรับ Self-Hosted ให้เปิดใช้งาน Add-on ในองค์กร Cloud ของคุณ ปล่อยให้การติดตั้งเช็คอินใบอนุญาตให้เสร็จสิ้น จากนั้นเปิดใช้งานการเข้าถึง API ในการตั้งค่าของการติดตั้ง ใช้ที่อยู่ HTTPS ของการติดตั้งแทนที่อยู่ Cloud API ในตัวอย่างเหล่านี้

  2. สร้างข้อมูลรับรอง

    สร้างข้อมูลรับรอง API ในการตั้งค่า เริ่มต้นด้วยพื้นที่โฆษณาสำหรับการฝึกปฏิบัตินี้เท่านั้น เลือกทั้งองค์กรหรือบริษัทเดียวเป็นขอบเขต ขอบเขตไม่สามารถเปลี่ยนแปลงได้ในภายหลัง สร้างข้อมูลรับรองใหม่หากคุณต้องการขอบเขตอื่น

  3. บันทึกความลับ

    ข้อมูลรับรอง API มีชื่อผู้ใช้และความลับ ข้อมูลลับจะแสดงเฉพาะเมื่อคุณสร้างหรือหมุนเวียนเท่านั้น บันทึกไว้ในเครื่องมือจัดการรหัสผ่านหรือที่เก็บข้อมูลลับ สามารถนำมาใช้ซ้ำได้จนกว่าจะถูกเพิกถอนหรือหมดอายุ ไม่ใช่รหัสยืนยันแบบครั้งเดียวหรือรหัสผ่านเข้าสู่ระบบของคุณ

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

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

    เลือกภาษาและติดตั้งการอ้างอิงตามรายการด้านล่าง ตัวอย่างใช้ที่อยู่ 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" }

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

การอนุญาตและขอบเขต

ค่าที่ตั้งไว้ล่วงหน้าจะเลือกความสามารถ ไม่ใช่ระดับการเข้าถึง การตั้งค่าจะสร้างข้อมูลรับรองใหม่ด้วย FullAccess ความสามารถที่เลือกไว้ยังคงจำกัดการเข้าถึง ตรวจสอบสิทธิ์ที่กำหนดเองก่อนบันทึก ReadOnly และ ReadWrite อธิบายถึงข้อมูลรับรองเก่าหรือที่สร้างขึ้นแยกต่างหาก ไม่ใช่ชื่อค่าที่ตั้งไว้ล่วงหน้า

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

องค์กร บริษัท และไซต์งาน

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

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