当社IoTサービスで受信したセンサの検知情報をAPI機能で取得する事が可能です。
API経由で定期的にデータを取得いただく事で、お客様側のアプリケーションに各種無線センサ情報や人数検知情報などを組み込んでいただく事が可能となります。
API機能は、下記のような利用目的に対応できます。
| 用途 | 内容 |
|---|---|
| お客様サービスの付加価値 | お客様サービスにてセンサの検知データを活用 |
１．API機能の特徴
API機能では、当社のIoTサービスで受信している各種センサの情報をお客様アプリケーションに組み込んでいただけるように、API機能をご提供しております。
当社クラウド環境のセンサーデータをAPI機能を通して取得できます。
REST API（GET）で JSONデータを取得できる為、お客様のアプリケーション側で容易に各種センサーのデータを組み込んでいただく事が可能です。
API仕様書をご用意しております。
取得できるデータは下記となります。
| No | 機能 | 説明 |
|---|---|---|
| 1 | センサーの一覧情報 | 登録済センサーの直近検知状況を一覧で取得（件数指定が可能） |
| 2 | 直近からのレコード数指定 | 指定したセンサーの検知情報を直近から指定レコード数分を取得 |
| 3 | 直近からの時間指定 | 指定したセンサーの検知情報を直近から指定時間分（Hour）を取得 |
| 4 | 期間指定 | 指定したセンサーの検知情報を期間指定で取得 |
API機能は、定期的（例：1分毎、5分毎など）にデータを取得いただく用途でのご利用を想定しております。
２．API機能を利用するには
API機能を利用するには、以下が必要となります。
| No | 必要項目 | 説明 |
|---|---|---|
| 1 | IoTサービスの導入 | API機能を利用する際には、当社IoTサービスの導入が必要となります。 |
| 2 | アクセス端末IP | APIへアクセスする端末情報（グローバル固定IPアドレス）が必要となります。 |
| 3 | ご利用料金 | API機能のご利用料金が必要になります。 |
３．利用シーン
下記のような場合が利用シーンになる想定です。
- センサ検知データをお客様のアプリケーション側で活用したい場合。
- お客様のクライアント端末（PCやスマホ）からインターネット上の当社サーバに接続いただく事が難しい場合。
- Webhook機能を利用する為の受信サーバのご用意が難しい場合。
４．API機能を使ったサンプルアプリケーション
API機能で取得したデータを使ったサンプルWebページをご確認いただけます。
- 定期的にJSONで取得したデータをDB保存
- DB内容をWebで表示
- API取得しDB保存している選択センサのデータを使ってグラフ表示
サンプルは「ファンブライト@ラボ」で確認いただけます。
５．参考：Webhook機能
定期的にAPIからデータを取得いただくのではなく、リアルタイムでデータを取得したい場合は、Webhook機能をご利用いただく事が可能です。
詳細は「Webhook機能」を参照ください。
６．サービス料金
API機能のご利用料金として、月額料金が必要になります。月額料金はAPIのコール数と取得データ数で変動します。詳細はお問い合わせください。