インテグレーションは、特定の機器のデータを外部サービスと連携するサービスです。
obniz Nowの外部サービスやHTMLなどで簡単に機器の情報を取得することができます。
インテグレーションの概要
インテグレーションは、1つの機器に対して1つ以上設定することができます。設定後、1分以内には適用が完了し転送可能となります。
インテグレーションには送信先やフォーマットの変換を定義し、認証キーなどを設定します。
インテグレーションの作成
サイドバーの外部連携>インテグレーションにあるインテグレーションを追加より追加できます。
インテグレーションでは、以下を指定し作成できます。
- 連携先 - RestAPIやGoogle Pub/Subなどが選択可能です
- マシン - ステートを連携させる対象の機器。複数を指定できます
- スキーマ - ステートの変換式です。jsonでの連携時のキーや値の変換を規定できます
- 送信間隔 - obniz Nowから送信する場合のタイミングを指定できます
連携先
利用可能な連携先は下記となります。
| 連携先 | 概要 | 必要な設定 |
|---|---|---|
| Google Pub/Sub | Google Pub/Subにデータをpublishします | 送信先のトピックと認証情報が必須です |
| REST API Push(未公開機能) | REST API(HTTPSリクエスト)にてデータをPOSTします | 送信先URLの設定が必須です。 ヘッダーをカスタマイズ可能です。 |
| REST API Pull(未公開機能) | REST APIのエンドポイントを生成可能です。 API KeyでのGETリクエストが可能となります。 |
API Keyの発行が必要です。 |
スキーマ設定
各機器が保有して保存している値をどのようなキーや値で出力できるかをスキーマとして設定できます。キーの出力を1つずつ対応表として設定できます。
存在する値は、選択している機器と設定によって異なります。
例えばobnizデバイスであれば、onlineなどの接続状態、温度センサーであればtemperatureといった温度やBluetoothの電波強度が含まれます。
変換先のパスを指定して追加することでスキーマを構築できます。
例えばtemperatureをtempというキーに。rssiをrssiとするjsonなら、以下の設定を適用します。
Transform Dataにより、現在の機器で値の変換を試すことができます。
時間と個体識別
送信時のtimestampフォーマットとdevice_id(機器の特定に用いる値)を変更できます。
フォーマットより書式を選択し、タイムゾーン設定が必要な場合はタイムゾーンから選択してください。
個体の識別は
- マシン名または機器IDのいずれかを送信
- 送信時のキーは任意に設定可能。デフォルトは
device_id
となっています。標準ではマシン名がdevice_idキーで文字列として送信されます。