התחל

אפשר גישה, צור אישור ובצע את בקשת ה-API הראשונה שלך.

1. הפעל גישת API

   בעלים של ארגון מאפשר גישה ל-API ול-MCP בהגדרות. התוסף המשותף עולה 20 דולר לארגון לחודש קלנדרי עבור ענן והתקנות מקושרות המאוחסנות בעצמם. במהלך תקופת ניסיון, ההגדרות מציגות האם גישה ל-API ול-MCP כלולה. אם מוצג "כלול בתקופת ניסיון", הפעל את הגישה שם; אחרת, עיין באפשרות ההפעלה בתשלום. השבתת גישה בתשלום אינה מסירה את החיוב של החודש הנוכחי.

   עבור Self Hosted, הפעל את התוסף בארגון הענן שבבעלותך, תן להתקנה להשלים את הצ'ק-אין של הרישיון שלה, ולאחר מכן הפעל גישת 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 מתארים אישורים ישנים יותר או שנוצרו בנפרד, לא שמות מוגדרים מראש.

ארגון, חברה ואתר

ארגון הוא הגבול ברמה העליונה של החשבון שלך. חברות מפרידות בין לקוחות או יחידות עסקיות בתוכו. אתרים מקבצים מכשירים בתוך חברה. אישור בהיקף חברה אינו יכול לגשת לנתונים של חברה אחרת.