Bắt đầu

Cho phép truy cập, tạo thông tin xác thực và thực hiện yêu cầu API đầu tiên của bạn.

1. Bật quyền truy cập API

   Chủ sở hữu tổ chức cho phép truy cập API và MCP trong Cài đặt. Tiện ích bổ sung dùng chung có giá 20 đô la Mỹ cho mỗi tổ chức mỗi tháng đối với các cài đặt Cloud và Self-Hosted được liên kết. Trong thời gian dùng thử, Cài đặt sẽ hiển thị xem quyền truy cập API và MCP có được bao gồm hay không. Nếu hiển thị "Đã bao gồm trong thời gian dùng thử", hãy bật quyền truy cập ở đó; nếu không, hãy xem xét tùy chọn kích hoạt trả phí. Việc vô hiệu hóa quyền truy cập trả phí không xóa khoản phí của tháng hiện tại.

   Đối với Tự lưu trữ, hãy bật tiện ích bổ sung trong tổ chức Đám mây của riêng bạn, để quá trình cài đặt hoàn tất quá trình đăng ký giấy phép, sau đó bật quyền truy cập API trong Cài đặt của cài đặt. Sử dụng địa chỉ HTTPS của chính bản cài đặt thay vì địa chỉ API đám mây trong các ví dụ này.

2. Tạo thông tin xác thực

   Tạo thông tin xác thực API trong Cài đặt. Chỉ bắt đầu với Hàng tồn kho cho hướng dẫn này. Chọn toàn bộ tổ chức hoặc một công ty làm phạm vi của nó. Phạm vi không thể thay đổi sau này; tạo thông tin xác thực mới nếu bạn cần một phạm vi khác.

3. Lưu bí mật

   An API credential has a username and a secret. Bí mật chỉ được hiển thị khi bạn tạo hoặc xoay nó. Lưu nó trong trình quản lý mật khẩu hoặc kho lưu trữ bí mật. Nó có thể tái sử dụng cho đến khi bị thu hồi hoặc hết hạn; nó không phải là mã xác minh một lần hoặc mật khẩu đăng nhập của bạn.

4. Đưa ra yêu cầu đầu tiên của bạn

   Chạy ví dụ cục bộ. It prompts for your credential, obtains an access token and lists the first page of devices. Giữ mã thông báo ở chế độ riêng tư. Những trang tài liệu này không bao giờ yêu cầu hoặc lưu trữ thông tin xác thực.

   Choose a language and install the dependencies listed below. Các ví dụ sử dụng địa chỉ API đám mây. Never paste real secrets into documentation, support tickets or shared logs.

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

Xác thực →

Quyền và phạm vi

Thiết lập sẵn chọn các khả năng, không phải cấp độ truy cập. Cài đặt tạo thông tin đăng nhập mới với FullAccess; các khả năng đã chọn vẫn hạn chế quyền truy cập. Xem lại các quyền tùy chỉnh trước khi lưu. ReadOnly và ReadWrite mô tả thông tin đăng nhập cũ hơn hoặc được tạo riêng, không phải tên thiết lập sẵn.

Tổ chức, công ty và địa điểm

Tổ chức là ranh giới cấp cao nhất cho tài khoản của bạn. Các công ty tách biệt khách hàng hoặc đơn vị kinh doanh trong đó. Các trang web nhóm các thiết bị trong một công ty. Thông tin xác thực trong phạm vi công ty không thể truy cập dữ liệu của công ty khác.