WV-ASA100のWEB APIの仕様書です。

WV-ASA100に保存されている画像やアラームの検索、照合リストの設定や統計情報を取得することができます。

本仕様書は、当社製品をご購入いただいたお客様で、APIの基本知識を有した方向けに、当該該当製品のAPIコマンドについて説明するための資料であり、当社からお客様にご提供できる情報の全てです。

当社は、本仕様書に記載している具体的なコマンドやサンプルプログラムの内容等については、サポートを提供しておりませんのであらかじめご了承ください。

また本仕様書を用いての、お客様における運用やご利用などにつきましては、当社は一切の責任を負いかねます。

不明点などある場合は必ず販売会社にご相談の上行っていただくようにお願いします。

本仕様書の内容および仕様は予告無く変更することがありますがご了承ください。

HTTP /1.1

リクエストヘッダー

クライアントからのHTTPリクエストを受付けた場合、アプリケーションが応答出来ない場合を除いて、 HTTPステータスコードは全て「200」が設定されます。

その他の一般的なHTTP通信エラーについては、「404」「403」などのステータスコードが返却されます。 その場合、本APIで定義するResponse bodyは返却されません。

Request

JSON形式で送信します。画像データを必要とするAPIの場合、画像データはBASE64形式にてエンコードする必要があります。

Response

応答は、HTTPステータスコードとJSON形式の本文で返却されます。 画像データが含まれる場合、BASE64形式にてエンコードされたデータが返却されます。

応答例

  {
    "status_body":
    {
        "status":true,
        "details": [
          {
            "srv_id":"9999",
            "code":"00000",
            "message":"OK"
          }         
        ]
    },
    "result_body":
    {
        *Depends on API
    }
  }

details 内の code 値に「00000」または「00001」が設定されている場合は status は true となります。

status が true の場合、詳細な応答情報が result_body に設定されます。 status が false の場合は、 result_body は設定されません。

details 内の srv_id は9999(固定)です。

クライアントとWV-ASA100の間の認証にはDigest認証を使用します。

WV-ASA100の設定を行うことでHTTPS通信が可能となります。通信プロトコルはTLS1.2のみ対応しています。

WV-ASA100インストール時はサーバー証明書には自己署名証明書が設定されます。

クライアントで証明書検証を行う場合、パブリックCAにより発行された証明書に置き換えていただくことを推奨します。

本ドキュメントはReDocを使用して生成されています。

About License

WV-ASA100に保存されている顔ベストショット画像、人物ベストショット画像、車両ベストショット画像を取得します。
クライアントは最初に検索開始のAPIで検索条件を指定し、検索セッションIDを取得します。

次に検索セッションIDを使用して検索結果の概要取得のAPIを送信します。
各検索結果画像の時刻情報とベストショット画像データを取得するための画像のキーを取得します。

最後にそれぞれの画像のキーに対して、ベストショット画像取得のAPIを送信して、画像データを取得します。