はじめてのVantiq [REST APIの基礎]

本記事では、Vantiq における「REST API」の基礎的な内容を説明します。

REST API

Vantiq の「Topic」「Type」「Procedure」といったリソースは、REST API を介してインターネットからアクセスすることができます。

Topicへのメッセージ送信

「Topic」に HTTP POST リクエストを送ると、リクエスト内のデータがメッセージ受信イベントとして「App」や「Rule」といったリソースに伝搬します。

Topicのユースケース

センサから取得した値やデバイスの状態遷移通知などの送信先として使うといったケースが考えられます

Typeへのレコード追加・更新

「Type」に HTTP POST リクエストを送ると、リクエスト内のデータがレコードとして「Type」に追加されます。「Type」のレコード更新は INSERT / UPDATE イベントとして 「App」や「Rule」などのリソースに伝搬します。

Typeからのレコード取得

「Type」に HTTP GET リクエストを送ると、「Type」内に保持されたレコードを取得できます。

Typeのユースケース

センサから取得した値などをリード/ライトする一次保存領域として使うといったケースが考えられます。

Procedureの実行・返り値の取得

「Procedure」に HTTP POST リクエストを送ると、リクエスト内のデータを引数として「Procedure」が実行され、返り値を取得できます。

Procedureのユースケース

クラウド側に一定期間貯めたセンサ値などを入力として演算処理を行うといったユースケースが考えられます。

セキュリティ

REST API へのアクセスは HTTPS の暗号化による通信経路の保護と、アクセストークンを用いたユーザー認証によってセキュアなアクセスを実現しています。

担当エンジニアからの一言

今回は「Topic」「Type」「Procedure」などの Vantiq リソースに REST API としてアクセスした場合に実行される処理の流れを簡単に説明しました。
REST APIに関する詳細な情報は下記Vantiq社サイトページをご参照ください。

※VantiqおよびロゴはVantiqの商標または登録商標です。
※本ページの記載内容は、当社が作成したものです。Vantiq社が承認しているものではありません。

Vantiq社関連ページ

おすすめリンク