ホームWeb設定ツールOpenAPIを介して連携する

OpenAPIを介して連携する

概要

OpenAPIを介して本機と通信するアプリケーションソフトウェアを利用する場合に、本機のOpenAPI設定をします。

本機の証明書を登録していれば、本機がサーバーとしてクライアントと通信するとき、通信をSSLで暗号化できます。

また、本機のSSDP(Simple Service Discovery Protocol)機能を利用することで、OpenAPI連携アプリケーションソフトウェアとのスムーズな連携ができます。

OpenAPIを介して連携する場合は、次の手順で設定してください。

  1. 本機のIPアドレスの設定など、ネットワークに接続して使うための設定をする
    • 設定のしかたは、こちらをごらんください。
  2. OpenAPIの基本設定をする
    • 設定のしかたは、こちらをごらんください。
  3. お使いの環境に応じて、次のオプション設定をする
    目的参照先
    本機とアプリケーションソフトウェアとの通信をSSLで暗号化したい

OpenAPIの基本設定をする

SSDP機能を有効にします。必要に応じて、OpenAPIで通信するポート番号を変更します。

  1. 管理者モードの[ネットワーク]-[SSDP設定]で、次の設定をします。
    設定説明
    [SSDP]
    OpenAPIを使うときは、[使用する]を選びます。
    次のことができるようになります。
    • 本機でOpenAPIサービスが起動したことを通知する
    • OpenAPIサービス検索に対して応答を返す
    初期値は[使用する]です。
    [マルチキャストTTL設定]
    必要に応じて、SSDPマルチキャストパケットの、TTL(Time To Live)を変更します。
    ルーターなどを1回経由するたびに値が1減少し、値が0になるとパケットが破棄されます。
    初期値は[1]です。
  2. 管理者モードの[ネットワーク]-[OpenAPI設定]で、必要に応じて、ポート番号を変更します(初期値:[50001])。
    • 通常はそのままお使いいただけます。
参考
  • Web Connectionおよび操作パネルで、複数のポート番号を同時に変更して[OK]をクリックすると、ポート番号重複エラーが表示されることがあります。ポート番号重複エラーが表示された場合は、一度にまとめて変更せず、1つずつ変更してください。

SSLで通信する

本機とアプリケーションソフトウェアとのOpenAPIを介した通信を、SSLで暗号化します。

  1. 本機の証明書を登録し、SSL通信を有効にします。
    • 詳しくは、こちらをごらんください。
  2. 管理者モードの[ネットワーク]-[OpenAPI設定]で、次の設定をします。
    設定説明
    [SSL/TLS使用]
    SSLで通信するときは、[SSL通信のみ可]または[SSL/非SSL通信可]を選びます。
    初期値は[非SSL通信のみ可]です。
    [ポート番号(SSL)]
    必要に応じて、SSL通信用のポート番号を変更します。
    通常はそのままお使いいただけます。
    初期値は[50003]です。
    [証明書検証強度設定]
    証明書の検証を行う場合は、検証する項目を選びます。
    それぞれの項目で[確認する]を選ぶと、その項目について、証明書の検証を行います。
    [クライアント証明書]
    本機に接続するクライアントに対して、証明書を要求するかどうかを選びます。
    初期値は[要求しない]です。
    [有効期限]
    証明書が有効期限内かどうかを確認します。
    初期値は[確認する]です。
    [CN]
    証明書のCN(Common Name)が、サーバーのアドレスと一致しているかどうかを確認します。
    初期値は[確認しない]です。
    [鍵使用法]
    証明書の発行者が承認した使用用途に沿って、証明書が使われているかどうかを確認します。
    初期値は[確認しない]です。
    [チェーン]
    証明書のチェーン(証明書のパス)に問題がないかどうかを確認します。
    チェーンの確認は、本機で管理している外部証明書を参照して行います。
    初期値は[確認しない]です。
    [失効確認]
    証明書が失効していないかどうかを確認します。
    証明書の失効確認は、以下の順番で行います。
    • OCSP(Online Certificate Status Protocol)サービス
    • CRL(Certificate Revocation List)
    初期値は[確認しない]です。
参照
  • 管理者モードの[セキュリティ]-[証明書検証設定]で、証明書の検証を行うかどうかを設定します。初期設定では、証明書の検証を行います。詳しくは、こちらをごらんください。