دليل SafeLine Open API: مصادقة رمز API

في الإصدار الأحدث من SafeLine (الإصدار 6.6.0 والإصدارات الأحدث)، تدعم Open API الآن المصادقة المستندة إلى رمز API المميز. على الرغم من عدم توفر وثائق API الرسمية حاليًا، إلا أنه يمكنك استخراجها بنفسك إذا لزم الأمر.

متطلبات:

• يجب عليك تسجيل الدخول باستخدام حساب المسؤول الافتراضي للوصول إلى هذه الميزة.
• يجب أن يكون إصدار SafeLine 6.6.0 على الأقل.

جيثب :https://github.com/chaitin/SafeLine
العرض التوضيحي:https://demo.waf.chaitin.com:9443/dashboard

كيفية استخدام واجهة برمجة التطبيقات المفتوحة

الخطوة 1: إنشاء رمز API المميز

أولاً، انتقل إلى إدارة النظام في SafeLine وقم بإنشاء رمز مميز لواجهة برمجة التطبيقات.

الخطوة 2: قم بتضمين رمز API المميز في طلباتك

عند إجراء استدعاءات واجهة برمجة التطبيقات، يتعين عليك تضمين الرمز المميز في رؤوس الطلب مثل هذا:

"X-SLCE-API-TOKEN": "Your API Token from SafeLine"

مثال: استخدام API Token في Python لإضافة موقع

فيما يلي مثال لكيفية استخدام SafeLine Open API مع رمز API المميز لإضافة موقع جديد في Python.

import requests
import json

# Define the header with your API token
header = {
    "X-SLCE-API-TOKEN": "Your API Token from SafeLine"
}

# API endpoint to add a site
url = 'https://:9443/api/open/site'

# Payload containing site details
payload = {
    "ports": ["80"],
    "server_names": ["*"],
    "upstreams": ["http://127.0.0.1:9443"],
    "comment": "",
    "load_balance": {
        "balance_type": 1
    }
}

# Convert payload to JSON
payload = json.dumps(payload)

# Send the POST request
response = requests.post(url=url, headers=header, data=payload, verify=False)

# Check the response
print(response.status_code)
print(response.json())

توضيح:

• يحتوي الرأس على رمز API المطلوب للمصادقة.
• إن عنوان URL هو نقطة النهاية لإضافة موقع (/api/open/site).
• تحدد الحمولة تفاصيل حول الموقع مثل المنافذ، وأسماء الخادم، والمنبع، وتكوين موازنة التحميل.

باتباع هذه الخطوات، يمكنك التفاعل بشكل آمن مع Open API الخاص بـ SafeLine باستخدام المصادقة المستندة إلى الرمز المميز، مما يتيح لك أتمتة وإدارة إعداد أمان الويب الخاص بك بسهولة.