نظرة عامة على API لـ Wallarm¶

توفر واجهة برمجة التطبيقات (API) من Wallarm تفاعلًا بين مكونات نظام Wallarm. يمكنك استخدام طرق API في Wallarm لإنشاء، الحصول على، أو تحديث الحالات التالية:

الثغرات الأمنية
الهجمات
الحوادث
المستخدمين
العملاء
عقد الفلترة
إلخ.

يتم تقديم وصف طرق API في واجهة Wallarm API المتاحة من واجهة Wallarm ← أعلى اليمين ← ؟ → واجهة Wallarm API أو مباشرةً عبر الرابط:

نقطة نهاية API¶

يتم إرسال طلبات API إلى عنوان URL التالي:

https://us1.api.wallarm.com/ لـالسحابة الأمريكية
https://api.wallarm.com/ لـالسحابة الأوروبية

مصادقة طلبات API¶

يجب أن تكون مستخدمًا مُعتمدًا لتقديم طلبات API إلى Wallarm. تعتمد طريقة مصادقة طلبات API على العميل الذي يرسل الطلب:

واجهة مرجع API
عميل API الخاص بك

واجهة Wallarm API¶

يتم استخدام رمز لمصادقة الطلب. يتم توليد الرمز بعد المصادقة الناجحة في حساب Wallarm الخاص بك.

قم بتسجيل الدخول إلى واجهة Wallarm باستخدام الرابط:
- https://us1.my.wallarm.com/ للسحابة الأمريكية
- https://my.wallarm.com/ للسحابة الأوروبية
قم بتحديث صفحة واجهة Wallarm API باستخدام الرابط:
- https://apiconsole.us1.wallarm.com/ للسحابة الأمريكية
- https://apiconsole.eu1.wallarm.com/ للسحابة الأوروبية
انتقل إلى طريقة API المطلوبة → القسم جربها، أدخل قيم الوسائط ونفِّذ الطلب.

عميل API الخاص بك¶

لمصادقة الطلبات من عميل API الخاص بك إلى API لـ Wallarm:

قم بتسجيل الدخول إلى حساب Wallarm الخاص بك في السحابة الأمريكية أو السحابة الأوروبية → الإعدادات → رموز API.
قم بإنشاء رمز للوصول إلى API لـ Wallarm.
افتح رمزك وانسخ القيمة من القطاع الرمز.
أرسل طلب API المطلوب مرورًا بقيمة الرمز في معامل الرأس X-WallarmApi-Token.

مزيد من التفاصيل حول رموز API →

نهج Wallarm في تطوير وتوثيق API¶

مرجع API من Wallarm هو تطبيق صفحة واحدة (SPA) مع جميع البيانات المعروضة يتم جلبها ديناميكيًا من API. يدفع هذا التصميم Wallarm إلى استخدام نهج إعطاء الأولوية لـ API عندما يصبح البيانات والوظائف الجديدة متاحة أولاً في API العام وكخطوة تالية يتم وصفها في مرجع API. عادةً ما يتم إصدار جميع الوظائف الجديدة بالتوازي في كل من API العام ومرجع API، ولكن أحيانًا يتم إصدار تغييرات API الجديدة قبل تغييرات مرجع API، وبعض الوظائف متاحة عبر API العام فقط.

يتم إنشاء مرجع API من Wallarm من ملف Swagger باستخدام أداة Swagger UI. يوفر مرجع API طريقة سهلة للتعرف على نقاط النهاية، والطرق، وهياكل البيانات المتاحة في API. كما يوفر طريقة بسيطة لتجربة جميع نقاط النهاية المتاحة.