شروع کریں۔

رسائی کو فعال کریں، ایک سند بنائیں اور اپنی پہلی API درخواست کریں۔

1. API رسائی آن کریں۔

   ایک تنظیم کا مالک ترتیبات میں API اور MCP رسائی کو فعال کرتا ہے۔ کلاؤڈ اور منسلک سیلف ہوسٹڈ تنصیبات کے لیے مشترکہ ایڈ آن کی قیمت فی تنظیم فی کیلنڈر ماہانہ US$20 ہے۔ آزمائش کے دوران، ترتیبات سے پتہ چلتا ہے کہ آیا API اور MCP رسائی شامل ہے۔ اگر یہ ٹرائل میں شامل دکھاتا ہے تو وہاں رسائی کو فعال کریں۔ بصورت دیگر بامعاوضہ ایکٹیویشن آپشن کا جائزہ لیں۔ بامعاوضہ رسائی کو غیر فعال کرنے سے موجودہ مہینے کا چارج ختم نہیں ہوتا ہے۔

   سیلف ہوسٹڈ کے لیے، اپنے کلاؤڈ آرگنائزیشن میں ایڈ آن کو فعال کریں، انسٹالیشن کو اس کا لائسنس چیک ان مکمل کرنے دیں، پھر انسٹالیشن کی سیٹنگز میں API رسائی کو فعال کریں۔ ان مثالوں میں کلاؤڈ API ایڈریس کے بجائے انسٹالیشن کا اپنا HTTPS ایڈریس استعمال کریں۔

2. ایک سند بنائیں

   ترتیبات میں API کی سند بنائیں۔ صرف اس واک تھرو کے لیے انوینٹری کے ساتھ شروع کریں۔ پوری تنظیم یا ایک کمپنی کو اس کے دائرہ کار کے طور پر منتخب کریں۔ دائرہ کار بعد میں تبدیل نہیں کیا جا سکتا۔ اگر آپ کو مختلف دائرہ کار کی ضرورت ہو تو ایک نئی سند بنائیں۔

3. راز کو محفوظ کریں۔

   API کی سند کا ایک صارف نام اور ایک راز ہوتا ہے۔ راز صرف اس وقت ظاہر ہوتا ہے جب آپ اسے بناتے یا گھماتے ہیں۔ اسے پاس ورڈ مینیجر یا راز کی دکان میں محفوظ کریں۔ منسوخ یا ختم ہونے تک یہ دوبارہ قابل استعمال ہے۔ یہ ایک بار کا تصدیقی کوڈ یا آپ کا لاگ ان پاس ورڈ نہیں ہے۔

4. اپنی پہلی درخواست کریں۔

   مقامی طور پر مثال چلائیں۔ یہ آپ کی اسناد کے لیے اشارہ کرتا ہے، ایک رسائی ٹوکن حاصل کرتا ہے اور آلات کے پہلے صفحے کی فہرست دیتا ہے۔ ٹوکن کو نجی رکھیں۔ یہ دستاویزات کے صفحات کبھی بھی اسناد طلب یا ذخیرہ نہیں کرتے ہیں۔

   ایک زبان کا انتخاب کریں اور ذیل میں درج انحصار کو انسٹال کریں۔ مثالیں کلاؤڈ 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 پرانے یا الگ سے تخلیق کردہ اسناد کی وضاحت کرتے ہیں، پہلے سے سیٹ ناموں کی نہیں۔

تنظیم، کمپنی اور سائٹ

ایک تنظیم آپ کے اکاؤنٹ کی اعلیٰ سطح کی حد ہے۔ کمپنیاں اس کے اندر گاہکوں یا کاروباری اکائیوں کو الگ کرتی ہیں۔ کمپنی کے اندر سائٹس گروپ ڈیوائسز۔ کمپنی کے دائرہ کار کی سند کسی دوسری کمپنی کے ڈیٹا تک رسائی حاصل نہیں کر سکتی۔