SafeLine オープン API ガイド: API トークン認証

SafeLine の最新バージョン (v6.6.0 以降) では、Open API が API トークンベースの認証をサポートするようになりました。公式 API ドキュメントは現在利用できませんが、必要に応じて自分でスクレイピングできます。

要件：

• この機能にアクセスするには、デフォルトの管理者アカウントを使用してログインする必要があります。
• SafeLine のバージョンは少なくとも 6.6.0 である必要があります。

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

オープンAPIの使い方

ステップ 1: API トークンを作成する

まず、SafeLine の システム管理 に移動し、API トークンを生成します。

ステップ 2: リクエストに API トークンを含める

API 呼び出しを行うときは、次のようにリクエスト ヘッダーにトークンを含める必要があります:

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

例: Python で API トークンを使用してサイトを追加する

以下は、API トークンで SafeLine Open 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) を追加するためのエンドポイントです。
• ペイロードは、ポート、サーバー名、アップストリーム、負荷分散構成などのサイトに関する詳細を指定します。

これらの手順に従うことで、トークンベースの認証を使用して SafeLine の Open API と安全にやり取りできるようになり、Web セキュリティ設定を簡単に自動化および管理できるようになります。