حدد علامة التبويب
ESET PROTECT On-Prem – جدول المحتويات

كيفية عمل API

أنواع استدعاء API

تتوفر أنواع استدعاء API المتمثلة في GET، وPOST، وDELETE في ESET PROTECT On-Prem API.

  • تحتوي استدعاءات GET على أي معلمات إدخال (ليس لها محتوى نص) وترسل البيانات مباشرة في عنوان URL. لا يمكن تعديل استدعاء الطلب؛ بل يتم تنفيذه فقط.
  • تتطلب استدعاءات POST وجود محتوى نص الطلب - حيث يتم توثيق المعلمات لكل استدعاء POST.
  • في طلبات API التي تتضمن ترقيم الصفحات (page_size)، يكون حجم الصفحة الافتراضي 100 والحد الأقصى للحجم هو 10000.

تتكون كل عملية استدعاء من:

  • نوع الاستدعاء
  • عنوان URL للطلب
  • عنوان الطلب (يمكن أن يتكون من الرمز المميز للمصادقة)
  • محتوى نص الطلب (يحتوي على بيانات، خاصة مع استدعاءات POST)

بنية استجابة الخادم

تتلقى كل عملية استدعاء لـ API استجابة من خادم REST. تتكون الاستجابة من رمز استجابة الخادم والاستجابة المنسقة كبيانات في JSON.

تتكون الاستجابة من:

  • رمز الخادم
  • محتوى نص الاستجابة
  • عناوين الاستجابة

أمثلة على استدعاءات API

GET

عرض إحدى السياسات (يتم أخذ Policy_UUID من وحدة التحكم على شبكة الإنترنت.):

الطريقة

GET

الوظيفة

Get Policy

عنوان URL

https://protect_server:9443/v2/policies/Policy_UUID

نص الرسالة

 

المصادقة

Bearer token

POST

انقل الجهاز إلى مجموعة ثابتة محددة (معرف جهاز الكمبيوتر مضمن في عنوان URL.):

الطريقة

POST

الوظيفة

Move device

عنوان URL

https://protect_server:9443/v1/devices/a13f7d4c-e689-47cb-939d-91b9c9664a57:move

نص الرسالة

{

"newParentUuid": "be3d7451-e625-47fb-8f29-f98d61b40db1"

}

المصادقة

Bearer token