平素は、当社に格別のご高配を賜り誠にありがとうございます。
この度、LiLz Gaugeをより便利にご利用頂くために、measurements API及び、cameras APIについて新しいAPIを提供いたします。
該当APIを外部連携機能にてご利用頂いているお客様には、お手数ですがAPIのエンドポイントを変更して頂く必要がございます。
＜影響のあるお客様＞
下記APIを利用した外部連携機能をご利用のお客様が対象となります。
・ GET /lilzgauge/api/measurements
・ GET /lilzgauge/api/cameras
なお、API機能をご利用でないお客様に関してはこれまで通りご利用頂けますのでご安心ください。また、新しいAPIはLiLz Gaugeのエンドポイントとしても導入され、ダッシュボード上で表示されるデータ表示スピードが改善されます。
＜新しいAPIへの更新計画＞
下記計画に基づき、新しいAPIのエンドポイントを適用いたします。
並行稼働期間では更新前のAPIも利用が可能ですが、並行稼働期間終了後には新しいAPIへエンドポイントの変更をしない限り、更新前のAPIはご利用頂けず404エラーが返却されるようになります。
更新計画
- 既存APIと新しいAPIの並行稼働期間 2021年10月6日~2022年3月31日 (約6か月)
- 新しいAPIのみでの稼働 2022年4月1日以降
＜GET /lilzgauge/api/measurementsのエンドポイント変更について＞
APIエンドポイントを下記のように変更いたします。
変更前：GET /lilzgauge/api/measurements
変更後：GET /lilzgauge/api/measurements/v3
変更内容：
- これまで1度の撮影で、1つの計器のみ読み取り結果を取得することができましたが、新しいAPIを適用することにより1度の撮影で指定した管理ユニットの全ての計器に紐づく読み取り結果を取得することができるようになります。 また、facility_idやgauge_id毎に読み取り結果をフィルターすることが可能となり、より細かい単位で測定結果の管理が可能となります。
- これまで1度のAPIコールで取得可能な読み取り結果の上限数は200件でしたが、新しいAPIを適用することによりページングの仕組みを提供することで、200件以上取得可能の読み取り結果を取得できるようになります。
詳細なAPIのレイアウトは下記APIリファレンスをご確認ください。
https://lilz.io/lilzgauge/docs#/measurements/get_lilzgauge_api_measurements_v3
ご対応頂きたい内容：
measurements APIのエンドポイントを上記変更に合わせて変更
＜GET /lilzgauge/api/camerasのエンドポイント変更について＞
APIエンドポイントを下記のように変更いたします。
変更前：GET /lilzgauge/api/camera
変更後：GET /lilzgauge/api/camera/v2
変更内容：
- これまで1度のAPI呼び出しで、1つの施設に紐づくカメラの撮影情報のみ取得が可能でしたが、新しいAPIの適用により、1つのmanagement unit idに属する全てのカメラの撮影情報を取得することが可能となります。 また、facility idとcamera idによるフィルタリング機能を提供し、より強力な管理が可能となります。
- これまで1度のAPI呼び出しで、全てのカメラ情報を取得していましたが、新しいAPIを適用することにより、50台以上のカメラ情報が存在する場合は、ページング機能を提供することで、より高速にカメラ情報を取得できるようになります。
- 新しいAPIの適用によりAPI呼び出し日から起算して30日前までのカメラ画像データを取得することができるようになります。30日以内に撮影されたカメラ画像が存在しない場合は、NULLが返却されるようになります。
- APIレスポンスにis_activeのフィールドを追加することで、LiLz Gauge上で無効にしているカメラを効率的にフィルターできるようになります。
詳細なAPIのレイアウトは下記APIリファレンスをご確認ください。
https://lilz.io/lilzgauge/docs#/cameras/get_lilzgauge_api_cameras_v2
ご対応頂きたい内容：
エンドポイントを上記変更に合わせて変更
APIレスポンスの出力レイアウト変更に伴う、連携先システムの改修
