ابدأ

قم بتمكين الوصول وإنشاء بيانات اعتماد وتقديم أول طلب لواجهة برمجة التطبيقات (API).

1. قم بتشغيل الوصول إلى واجهة برمجة التطبيقات (API).

   يُفعّل مالك المؤسسة الوصول إلى API وMCP في الإعدادات. تبلغ تكلفة الإضافة المشتركة 20 دولارًا أمريكيًا لكل مؤسسة شهريًا للتثبيتات السحابية والمستضافة ذاتيًا المرتبطة. خلال الفترة التجريبية، تُظهر الإعدادات ما إذا كان الوصول إلى API وMCP مُضمّنًا. إذا كان مُضمّنًا في الفترة التجريبية، فعّل الوصول من هناك؛ وإلا فراجع خيار التفعيل المدفوع. تعطيل الوصول المدفوع لا يُلغي رسوم الشهر الحالي.

   بالنسبة إلى الاستضافة الذاتية، قم بتمكين الوظيفة الإضافية في مؤسستك السحابية المالكة، واترك التثبيت يكمل تسجيل الوصول إلى الترخيص، ثم قم بتمكين الوصول إلى واجهة برمجة التطبيقات (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 إلى بيانات اعتماد قديمة أو تم إنشاؤها بشكل منفصل، وليس إلى أسماء الإعدادات المسبقة.

التنظيم والشركة والموقع

المنظمة هي الحد الأعلى لحسابك. تقوم الشركات بفصل العملاء أو وحدات الأعمال داخلها. تقوم المواقع بتجميع الأجهزة داخل الشركة. لا يمكن لبيانات الاعتماد على مستوى الشركة الوصول إلى بيانات شركة أخرى.