- HOME
- 機能リスト
- 外部システムとの連携
- APIの概要
SK VMSはAPIを提供しています。APIについての説明と使用例について紹介します。
SK VMSサーバーAPIは、第三者システムのAPI呼び出し標準セットを提供します。APIを使用して開発者は、デスクトップビューアで利用可能なほぼすべての機能にアクセスできます。システムリソース(サーバー、カメラ、ユーザー)のクエリ/管理や、ユーザーとアクセス許可の管理、ライブまたは録画したビデオをシステムから取り出したり、イベントの生成、ルールの作成、PTZカメラの制御など含め、他にも多くのことができます。
SK VMS サーバーAPIはRESTFUL標準の元のWeb APIとして提供します。開発者はPOSTやGETリクエストによってHTTP経由でSK VMS サーバーと簡単にやりとりすることができます。SK VMS サーバーAPIは大きく分けて4種類あります。
SK VMS サーバーAPIの種類、リクエスト時に必要なパラメータはSK VMS サーバー内に設けているドキュメントページから参照できます。ウェブブラウザを開いて以下のURLにアクセスしてください。
APIのHTTPリクエストは、適切なユーザー認証を行うことで発行することができます。
ユーザー認証はダイジェスト認証とベーシック認証に対応しています。 ダイジェスト認証はより安全な認証で、ワークフローはAPIのドキュメントページに記載されています。 ベーシック認証はより簡単な認証で、ユーザー名とパスワードをURLに追加するだけです。
APIのHTTPリクエストはAPIの種類によってメソッドやパラメータが異なります。ドキュメントページより適切なメソッド、パラメータを確認して、HTTPリクエストを送信してください。
SK VMSサーバーAPIには、特定のカメラで録画を開始/停止する直接的なAPIがありません。しかし、「一般イベント」と呼ばれるイベントと「カメラ録画」アクションをイベントルール設定することで、録画の開始/停止をAPIで制御することができます。 ここではSK VMS サーバーがHello_World文字列を受信したときに、録画の開始/停止の制御をする設定例を紹介します。
なお、ここでの紹介以外にもsaveCameraUserAttributesList APIのscheduleTasksやscheduleEnabledパラメータで録画スケジュールの有効/無効、つまり録画の開始/停止を制御する方法もあります。
イベント
アクション
設定の完了後、SK VMSサーバーに録画開始/停止を表す一般イベントのHTTPリクエストを送信することで録画の制御ができます。なお、リクエストにはユーザー認証が必要であることにご注意ください。
SK VMS APIへの理解を深めたい皆様、こんにちは。 前回のAPI講座は、サーバーの状態を取得す […]
SK VMSはサーバーとクライアントを組み合わせて使うソフトウェアです。サーバーとクライアントの役割 […]
SK VMSではカメラに搭載されている様々な機能を制御する事が出来ます。 一般的な機能としてはPTZ […]
ストレージに障害が発生した場合、一刻も早い対策を行う必要があります。そこでストレージ障害の発生確認方 […]