Qwatch APIダウンロードページ

ネットワークカメラ「Qwatch」 API仕様書ダウンロード ファイルアイコン

WHAT CAN APIAPIでできること

  • カメラの映像(静止画・動画)を取得することができます

    お客様が開発するアプリケーションからリクエストを送ることで、
    カメラの映像(静止画・動画)を取得することができます。

  • Webページにライブ画像を取り込むことができます

    HTMLを記述することでWebページにライブ画像を
    取り込むことができます。※Webページを閲覧するパソコンとカメラが同一のネットワーク内に設置されている必要があります

  • カメラからクラウドサーバーなどへ静止画・動画を自律的に送信することができます

    カメラからクラウドサーバーなどへ静止画・動画を
    自律的に送信することができます。(クラウドモード)
    ※対応カメラはAPI対象製品をご確認ください

CASE STUDY導入事例

その他関連サービス

OPTiM AI Camera
カメラにつないですぐに使えるAI画像解析サービス
ピースアイ
スマートフォンやタブレットから「映像」で見守りができる「クラウド型スマートホーム」サービスに採用いただいています。

API対象製品

下表は右にスクロールできます。
TS-NA230WP
TS-NA230WP
TS-NS410W
TS-NS410W
TS-NS310W
TS-NS310W
TS-NS110W
TS-NS110W
API
クラウドモード
API
NEW
ONVIF® ONVIF S ONVIF S ONVIF S T
TS-NA220W
TS-NA220W
TS-NA220
TS-NS210
TS-WRFE
TS-WRFE
TS-WRLP
TS-WRLP
TS-WRLC
TS-WRLC
API
クラウドモード
API
ONVIF® ONVIF S
ONVIF®とは
ONVIF(オープンネットワークビデオインターフェース・フォーラム)はネットワークカメラ製品間の共通規格インターフェースを策定するフォーラム、またはその標準規格です。
ONVIF規格に対応することで、異なるメーカーのカメラやレコーダーを組み合わせて利用できるようになります。 ※全ての機器との動作を保証するものではありません。

ONVIFを使った活用事例

Gravio
様々な入力デバイス、カメラ、外部サービスAPIなどに繋げることができることができる、エッジコンピューティング型のIoT統合ソフトウェアです。Qwatchと連携することで人数カウントなどのAIをご利用いただけます。

DOWNLOADダウンロード

API仕様書のご利用にあたって

本仕様書は、弊社製品をご購入いただいたお客さまでネットワークの基本知識を有した方向けに、当該製品のAPIコマンドによる制御について説明するための資料です。本ページ下部の「使用許諾書」にご同意いただいた上で、ダウンロードしていただきご利用ください。

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

ダウンロードファイル構成
ファイル名
qwatch_api_v1_12.zip
内 容

Qwatchシリーズ API仕様書_Rev1.5.pdf
(対象カメラ:TS-WRFE、TS-WRLC)

TS-NS310W_NS410W_NA230WP_API仕様書_Rev1.4.html
(対象カメラ:TS-NS410W、TS-NS310W、TS-NA230WP)

TS-WRLP_NA220シリーズ_NS210_NS110W_API仕様書_Rev1.8.html
(対象カメラ:TS-WRLP、TS-NA220W、TS-NA220、TS-NS210、TS-NS110W)

改訂履歴はこちらよりご確認いただけます>>
使用許諾書について

この使用許諾書(以下、「使用許諾書」とします)は、弊社製のネットワークカメラ用のAPIおよびそれに関するドキュメント等(以下、「API等」とします)を本ページよりダウンロードし、使用されるにあたって、遵守いただきたい条件をまとめたものです。
ダウンロードされる前に以下の内容を必ずご一読いただき、同意いただいたうえでご利用ください。なお、API等をダウンロードされた場合、使用許諾書の条件に同意いただいたものとみなします。

1.著作権

API等の著作権は、弊社または弊社が使用許諾を受けた第三者に帰属します。お客様には弊社が許諾する範囲でのみAPIを使用する限定的なライセンスが与えられます。

2.使用条件

お客様は、弊社のネットワークカメラ(以下、「弊社製品」とします)を検証することおよび弊社製品とお客様の製品・サービスを組み合わせて第三者に提供することを目的(以下、「本目的」とします)としてのみ、API等を使用する非独占的な権利を有します。ただし、お客様は次のことを行うことはできません。

  1. (a)API等を本目的の範囲を超えて複製、改変、頒布、公衆送信および使用すること。
  2. (b)API等を第三者に販売および譲渡すること。
  3. (c)API等を利用して以下の行為を行うこと
    1. [ⅰ]法令や公序良俗に反する行為
    2. [ⅱ]第三者の権利・利益を侵害する行為およびそのおそれがある行為
    3. [ⅲ]その他、弊社が不適切と判断する行為
  4. (d)API等をリバースエンジニア、逆コンパイル、または逆アセンブルすること。
  5. (e)API等を米国、日本その他の国の輸出管理法令・規則等に違反して輸出すること。
  6. (f)API等を、大量破壊兵器又は、通常兵器の開発・製造・使用若しくは貯蔵の為に流用すること。
3.違反

お客様が使用許諾書の条件に違反した場合、お客様はAPI等およびこれらの複製物の全てを破棄していただくものとします。また、当該違反により紛争が生じた場合は、お客様の責任と負担にてこれを解決し、弊社に何らの損害を及ぼさないものとします。

4.非保証

API等は現状有姿の状態で提供されるものとし、その完全性、正確性、有用性、非侵害性、目的適合性について、弊社は一切の保証をしません。また、API等はネットワークカメラの検証の参考として提供されるものですので、お客様がそれを利用した結果お客様や第三者に損害が生じた場合でも、弊社はいかなる責任も負いません。

5.サポート

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

6.提供の中止、変更など

API等の提供は、予告なく中止、または内容や条件を変更する場合があります。

サンプルコードのご案内
ネットワークカメラを使ったご利用シーンを想定したサンプルコードをGithubにて公開しています。システム開発やソリューション検討時の参考にご活用ください!
※リンク先の「example」よりサンプルコードをダウンロードいただけます。
※サンプルソースコードのご利用に際しても、API仕様書の「使用許諾書」が適用されます。事前にご一読の上ダウンロード・ご使用ください。

FAQよくある質問

カメラへAPIの設定をしても応答がありません
総当たり攻撃の防止などセキュリティ上の観点から、API実行時には成否の結果を出力していません。
APIコール時にはパラメータに間違いがないか十分ご確認のうえご利用をお願いします。
APIの設定ができたかわかりません。
現在の設定を知る方法はありますか?
設定変更前後で現在の設定を取得し、取得内容の差分をご確認いただくことでご確認いただけます。
現在の設定は以下のAPIにて取得できます。 http://<カメラのIPアドレス>/camera-cgi/admin/param.cgi?action=listall
APIの設定をしたのに意図した動作になりません
リクエストに誤りが無いか確認してください。下記のような場合は正しく設定されません。
例:パラメーター名が不足している、誤字がある 誤:Cloud_cloudserver
正:Cloud_cloudserver_url
例:複数パラメータをつなげる際、スペースが入ってしまっている。 誤:img_jpg2%2F &Cloud_Picture_enable=
正:img_jpg2%2F&Cloud_Picture_enable=
ローカルネットワーク内でカメラデバイスを検索、特定するためにはどうしたらいいですか?
MagicalFinderを利用し、IPアドレスを確認してください。
「API対象製品」でONVIFマークのついている製品およびTS-NS110Wは、ws-discoveryでのデバイス検索もご利用いただけます。
カメラへのアクセス(WebAPI、コンテンツ)に必要となる認証方法について教えてください
(UserName、Password,証明書など)
Digest認証を行います。UserName,Passwordはカメラのアカウント設定の内容となります。
API(rtsp://○○やhttp://○○)から映像を取得する場合、
使用されるプロファイルはどのようになりますか?
http://<カメラのIPアドレス>:<カメラのHTTPポート番号>/<h264_profile1>.mjpeg
http://<カメラのIPアドレス>:<カメラのHTTPポート番号>/<h264_profile2>.mjpeg
のように、アクセスするURLによってプロファイルを選択することができます。
rtspも同様にsdpを選択可能です。<>の中の名称については、各カメラのポート設定やビデオ設定を参照するか、APIにて現在の設定を取得することでご確認いただけます。
「APIでできること」にある「カメラからクラウドサーバーなどへ静止画・動画を自律的に送信する」機能に
対応している機種はどれですか?
2022年11月現在、以下の機種が対応しています。
TS-WRLP、TS-NA220W、TS-NA220、TS-NS210、TS-NS110W
どうしたらクラウドサーバーなどへの送信がはじまりますか?
Cloud_cloudserver_urlを指定することでクラウドモードが開始します。
・Cloud_Settings_interval で指定された秒数毎に、クラウドサーバーからserverConfig.xmlを取得します
・Cloud_Picture_enable=1を指定することで、静止画が送信されます
・Cloud_EventUpload_enable=1を指定することで、イベント情報がXML形式とjpeg、mp4で送信されます

映像はCloud_cloudserver_urlを指定したうえで、RTMP設定を行うことで利用可能です。
・Cloud_RTMP_urlを指定し、Cloud_Movie_enable=1 にすることで動画が送信されます。
動作検知をしたときだけクラウドへ送ることはできますか?
Cloud_Picture_enable=0
Cloud_Movie_enable=0
に設定したうえで Cloud_EventUpload_enable=1 にすることで検知時の静止画、動画のみをクラウドに送ることができます。
検知時の動画は不要で静止画だけアップロードするには、検知設定で「検知時の撮影方法」を動画→スナップショットに変更してください。
クラウドサーバーへRTMP送信されません
・RTMP_urlとMovie_enableを設定したのち、カメラを再起動してください。
・URLの末尾に「/」をつけてください。カメラ側のURLの処理として「/」を終端として処理しています。

~以下はTS-WRLPのみ~
・RTMP_urlの最大文字数は120文字となります。ポート番号がRTMPのデフォルトのままであれば、「:1935」を省略してみてください。(Azureの場合、URLは104~127文字となるようです)
・TS-WRLPは認証機能をサポートしていないため、RTMPサーバー側の認証を「なし」にしてお試しください。
このページのトップへ
PC版を表示