SK VMSブログ

SK VMS サーバーAPI 入門編 -APIとは-

SK VMSの知識 —

  • このエントリーをはてなブックマークに追加

サーバー監視でお困りの皆様、こんにちは。
こちらでは、SK VMSサーバーの監視を自動化したい、という場合のtipsを紹介していきます。
初回は入門編ということで、SK VMSのサーバーAPIについて紹介します。

====
対象読者:

  • サーバー監視(または情報の自動取得)に興味がある
  • カメラからイベント通知を送りたい
が、何をどうすればいいのか分からない
====

SK VMSではサーバーから情報を取得する、あるいは設定を変更するためのAPIを提供しています。
サーバーをインストール済みの方は、サーバーwebページからドキュメントを参照できます。

サーバーをインストール済みの方は、サーバーwebページからドキュメントを参照できます。

APIは「アプリケーション・プログラミング・インターフェース」の略ですが、これだけ聞いても何のことだかわからないと思いますので、ここでは「特定のURLにアクセスすると、webページの代わりにサーバーの情報が取得できる」と考えてください。このサーバーAPIを利用することで、VMSクライアントやwebページを手動であれこれ操作しなくても目的の情報が取れる、というわけです。

それでは早速例を見てみましょう。
通常、webブラウザで http://<サーバーIP>:7001 にアクセスするとログイン画面が表示され、ログインに成功すれば次の画像のような画面になりますね。

webブラウザでhttp://<サーバーIP>:7001にアクセス、ログインが成功した時の画面

ところが、特定のURLにアクセスした際は次の画像のように文字だけが大量に表示されます。
http://<サーバーIP>:7001/ec2/getCamerasEx

特定のURLにアクセスすると文字だけが大量に表示されます。

何も知らないとなにかのバグじゃないかと思ってしまいますが、大丈夫です。何かが壊れた訳ではありません。

この /ec2/getCamerasEx というURLではVMSに登録されているカメラ情報が取得できるのですが、JSONという文字列ベースの形式でデータが送られているので、大量の文字が表示されています。
JSON viewerというChrome拡張を使用すると、次のように見やすく整頓できます。

JSON viewerというChrome拡張を使用すると、見やすく整頓できます。

最初の文字だけの画像に対応するのはこの辺です。

見比べればなんとなく、[ ] や { } 、カンマやコロンで各データが区切られているのがわかるでしょうか。
整形していない方は人間からすると見辛いですが、機械に任せれば正しく解釈できますし、 余計な改行やインデントがない分、データも少なくて扱いやすいです。

今回は入門編ということで、ひとまずここまでにしたいと思います。
SK VMSのサーバーAPIとは何か、どうすれば使えるのか、お伝えできていれば幸いです。
データの読み方や、他にどのような情報を取得できるのかは次回以降に紹介していきます。

それでは、よきAPIライフを!

メルマガ登録

月に1度ほどお得な情報、お役立ち情報をお届けします。ぜひご登録ください!(過去のメルマガを見る)