コンテンツにスキップ

API の設定

API アクセスはデフォルトでオフになっています。これをオンにして、特定の IP アドレスに対してアクセスを許可する必要があります。

管理者のエンドポイントからの API 呼び出しを許可する

管理者のエンドポイントからの API 呼び出しを許可するには、次の手順を実行します。

  1. バックアップ & ファームウェア > API」に移動します。
  2. API 設定」を選択します。

    API によって設定を取得、指定、削除することを許可できます。

  3. 許可されている IP アドレス」に、管理者の IP アドレスを入力します。

    これらの IP アドレスからのみ変更することができます。Web 管理コンソールにアクセスする IP アドレスを取得するには、次の手順を実行します。

    1. ログビューアに移動し、リストから「管理者」を選択します。
    2. サインイン元の IP アドレスを確認します。

アクセス許可を厳しく設定し、特定の管理者のみにアクセスを許可するには、API アクセスを管理者に許可するを参照してください。

認証リクエストを作成する

ファイアウォールでは、ファイアウォール内の認証情報に基づいて管理者の API リクエストを認証します。

API クライアントは、セキュリティを確保するために、HTTPS 経由で認証情報をファイアウォールに送信します。HTTPS は、クライアントとサーバー間の安全なチャネルを提供し、転送中のデータを暗号化して、権限のないユーザーが通信を傍受または変更しないようにします。

最初に、ポート、IP アドレス、認証情報が機能することを確認することを推奨します。

ペイロードは、次の URL を使用して送信する必要があります。

https://<ファイアウォールの IP アドレス>:<ポート>/webconsole/APIController

次のいずれかのメカニズムを使用して、接続と認証情報をテストできます。

Postman アプリケーションで、管理者の認証情報を次のように入力します。

  1. コレクション」のプラスボタンをクリックして、新しいコレクションを作成します。

    新しい Postman コレクションを追加する。

  2. コレクションの「Add a request」をクリックします。

    コレクションに新しいリクエストを追加する。

  3. New Request」で、次の構文を使用してファイアウォールの詳細を入力します。

    https://<ファイアウォールの IP アドレス>:<ファイアウォールのポート>/webconsole/APIController
    

    Postman でリクエストを送信します。

  4. Body」、「form-data」の順にクリックします。

    Postman の Body と form-data。

  5. Key」に reqxml と入力します。

  6. Value」に、次の構文を使用して認証情報を入力します。

    <Request>
        <Login>
            <Username><管理者のユーザー名></Username>
            <Password><管理者のパスワード></Password>
        </Login>
    </Request>
    

    認証リクエストを入力する。

  7. 送信」をクリックします。

Linux エンドポイントまたはファイアウォールのコマンドラインで、次の構文を使用して認証情報を入力します。

curl -k "https://<ファイアウォールの IP アドレス>:<ファイアウォールのポート>/webconsole/APIController?reqxml=<Request><Login><Username><管理者のユーザー名></Username><Password><管理者のパスワード></Password></Login></Request>"

次の応答が表示されます: Authentication successful. (認証が正常に完了しました。)

API エクスプローラ

API を使用して、ユーザーのサインインおよびサインアウトができます。

API を使用してユーザーをサインインすると、「現在のアクティビティ > ライブユーザー」で、ユーザーのクライアントタイプが「API クライアント」として表示されます。

<Request><LiveUserLogin><UserName>admin</UserName><Password>abcd</Password><IPAddress>10.21.18.15</IPAddress><MacAddress>00:0C:29:2D:D3:AC</MacAddress></LiveUserLogin></Request>
<Request><LiveUserLogout><Admin><UserName>admin</UserName><Password>abcd</Password></Admin><UserName>sophos</UserName><IPAddress>10.21.18.15</IPAddress></LiveUserLogout></Request>
https://<Sophos Firewall IP address>:4444/webconsole/APIController?SecureStorageMasterKey=Passw0rd@12345&reqxml=<Request><LiveUserLogin><UserName>admin</UserName><Password>abcd</Password><IPAddress>10.21.18.15</IPAddress><MacAddress>00:0C:29:2D:D3:AC</MacAddress></LiveUserLogin></Request>

その他のリソース