SafeLine Open API Guide: API-Token-Authentifizierung

In der neuesten Version von SafeLine (v6.6.0 und höher) unterstützt die Open API jetzt API-Token-basierte Authentifizierung. Obwohl die offizielle API-Dokumentation derzeit nicht verfügbar ist, können Sie sie bei Bedarf selbst herunterladen.

Anforderungen:

• Sie müssen mit dem Standardadministratorkonto angemeldet sein, um auf diese Funktion zugreifen zu können.
• Die SafeLine-Version muss mindestens 6.6.0 sein.

GitHub:https://github.com/chaitin/SafeLine
Demo:https://demo.waf.chaitin.com:9443/dashboard

So verwenden Sie die Open API

Schritt 1: Erstellen Sie ein API-Token

Navigieren Sie zunächst in SafeLine zu Systemverwaltung und generieren Sie ein API-Token.

Schritt 2: Fügen Sie das API-Token in Ihre Anfragen ein

Bei API-Aufrufen müssen Sie das Token wie folgt in die Anforderungsheader einfügen:

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

Beispiel: Verwenden eines API-Tokens in Python zum Hinzufügen einer Site

Unten finden Sie ein Beispiel dafür, wie Sie die SafeLine Open API mit einem API-Token verwenden, um eine neue Site in Python hinzuzufügen.

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())

Erläuterung:

• Der Header enthält das erforderliche API-Token für die Authentifizierung.
• Die URL ist der Endpunkt zum Hinzufügen einer Site (/api/open/site).
• Die Payload gibt Details über die Site an, wie Ports, Servernamen, Upstreams und Lastausgleichskonfiguration.

Wenn Sie diese Schritte befolgen, können Sie mithilfe der tokenbasierten Authentifizierung sicher mit der offenen API von SafeLine interagieren und so Ihre Web-Sicherheitseinrichtung problemlos automatisieren und verwalten.