شروع کنید

دسترسی را فعال کنید، یک اعتبارنامه ایجاد کنید و اولین درخواست API خود را انجام دهید.

1. دسترسی API را روشن کنید

   مالک سازمان، دسترسی API و MCP را در تنظیمات فعال می‌کند. هزینه افزونه اشتراکی برای هر سازمان در هر ماه تقویمی ۲۰ دلار آمریکا برای نصب‌های ابری و خود-میزبانی مرتبط است. در طول دوره آزمایشی، تنظیمات نشان می‌دهد که آیا دسترسی API و MCP گنجانده شده است یا خیر. اگر گزینه Included in trial را نشان می‌دهد، دسترسی را در آنجا فعال کنید؛ در غیر این صورت، گزینه فعال‌سازی پولی را بررسی کنید. غیرفعال کردن دسترسی پولی، هزینه ماه جاری را حذف نمی‌کند.

   برای Self-Hosted، افزونه را در سازمان Cloud مالک خود فعال کنید، به نصب اجازه دهید بررسی مجوز خود را کامل کند، سپس دسترسی API را در تنظیمات نصب فعال کنید. در این مثال ها به جای آدرس Cloud API از آدرس HTTPS خود نصب استفاده کنید.

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 اعتبارنامه‌های قدیمی‌تر یا جداگانه ایجاد شده را توصیف می‌کنند، نه نام‌های از پیش تعیین‌شده.

سازمان، شرکت و سایت

یک سازمان مرز سطح بالای حساب شما است. شرکت ها مشتریان یا واحدهای تجاری را در آن جدا می کنند. سایت ها دستگاه ها را در یک شرکت گروه بندی می کنند. اعتبارنامه ای با محدوده شرکت نمی تواند به داده های شرکت دیگری دسترسی داشته باشد.