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