Bevywise IoTプラットフォーム APIドキュメント

導入事例

このドキュメントで提示されたREST APIは、通信するために使用できます お問い合わせ IoT ソリューションのモバイルアプリケーションを作成する、または 統合 Amazon Alexaや他の高度なアプリケーションで、Bevywise IoT Platfom。

Bevywise IoTプラットフォームの前提条件

Bevywise IoT Platformは2種類の認証をサポートしています メカニズム ユーザーは、IoT を利用することができます。 モバイルアプリケーションとAlexaAmazonと統合するプラットフォーム または 他の高度の適用。

IoT を設定したら クラウド環境のプラットフォーム、ログイン お問い合わせ 管理者コンソールにアクセスし、アプリケーションに基づいて認証を設定するために、URL の下に移動します。


サーバ IP またはドメイン名/o/applications/

タイプ1:直接ログインの認証

モバイルアプリケーションをユーザ名でログインしたい場合 パスワード API を経由して直接、以下に詳細を記入し、保存します。

名前: < アプリケーションの名前>
クライアント ID: < 自動的に変更されません>
クライアントシークレット: < 自動的に変更されません>
クライアントタイプ: 機密情報
認可の付与のタイプ: リソースオーナーパスワードベース
リダイレクトURL: < 空にする>

設定が完了したら、クライアントID、クライアントIDを取得します。 秘密, クライアントタイプと認可付与タイプ。 詳細をバックアップして、詳細をさらにバックアップする 使用。

タイプ2:Amazon Alexaスキルセットまたは他の認証 アプリケーション

この認証は OAUTH2 認証に基づいています。 のために使用される 「OAUTH2認証コード付与フロー」をAmazon Alexaのスキルで使用 セットまたは Googleの援助。 以下に詳細を記入し、保存してください。

名前: < アプリケーションの名前>
クライアント ID: < 自動的に変更されません>
クライアントシークレット: < 自動的に変更されません>
クライアントタイプ: 機密情報
認可の付与のタイプ: 認証コード
リダイレクトURL: < urlsをリダイレクト>

設定が完了したら、クライアントID、クライアントIDを取得します。 秘密, クライアントタイプと認可付与タイプ。 詳細をバックアップして、詳細をさらにバックアップする 使用。

サインアップ API

この API は、Bevywise IoT の新しいアカウントを作成するのに役立ちます。 プラットフォーム

リクエスト:

Httpの要求:

ポスト サーバ IP またはドメイン 名前/bwiot/api/v1/auth/signup/

パラメーター:

パラメータ バリューディテール
パスワード ユーザーのメールID
パスワード パスワード文字列
クライアントID 認証を作成するときに生成されるクライアント ID を貼り付ける
クライアント_secret 認証を作成するときに生成されるクライアントシークレットを貼り付ける
助成金の種類 パスワード [単語を正確に使用し、ユーザーに与えない] パスワード
応答:

成功について:

お問い合わせ
"bwapi-status": "成功",
"userid": "email_id",
「トークン」:「トークン」、
"expires_in": "36000",
"refresh_token": "リフレッシュトークン",
"bwapi-status-reason": "successfullsignup"
お問い合わせ

失敗時:

お問い合わせ
"bwapi-status": "fail"
message': 'Account は受信したデータで作成できません
{"username": ["そのユーザ名が既に存在しているユーザ"]} お問い合わせ
お問い合わせ

ログイン API

この API は、Bevywise IoT プラットフォームにログインするのに役立ちます。

タイプ1:

通常のトークンを取得するか、アプリケーションへの直接ログイン ユーザー名とユーザー名 パスワード

リクエスト:

Httpの要求:

ポスト サーバ IP またはドメイン名/ビット/api/v1/auth/login/

パラメーター:

パラメータ バリューディテール
パスワード ユーザーのメールID
パスワード パスワード文字列
クライアントID 認証を作成するときに生成されるクライアント ID を貼り付ける
クライアント_secret 認証を作成するときに生成されるクライアントシークレットを貼り付ける
助成金の種類 パスワード [単語を正確に使用し、ユーザーに与えない] パスワード
応答:

成功について:

お問い合わせ
"bwapi-status": "成功",
「トークン」:「トークン」、
"refresh_token": "refreshトークンの値",
"expires_in": "36000",
"bwapi-status-reason": "successfulllogin"
"userid": "email_id",
お問い合わせ

失敗時:

お問い合わせ
"bwapi-status-reason": "無効な認証"
"bwapi-status": "fail"
お問い合わせ

タイプ2

認証を設定した後に生成された詳細を使用する ビービービワイズIoT プラットフォームを統合 あなたの alexa のスキル セット サーバーまたは他のへの Bevywise IoT のプラットホーム サーバ oauth2 認可コードフローを持っています。
その他の必要な URL や例については、以下の詳細に基づいて詳細を提供 オース2 認証コードフロー

認可の付与タイプ: Auth コードの付与
認可URL:https://devicemanager.bevywise.com/o/authorize/
アクセストークン URL: https://devicemanager.bevywise.com/o/token/
クライアント ID: 認証から作成されたクライアント ID をコピーして貼り付ける
クライアントシークレット: 認証から作成したクライアントシークレットをコピーして貼り付ける
タイプ2
クライアント認証 スキーム: Http 基本
スコープ: 読み書き

注意:ログイン API は通常のアプリケーションと通常のアプリケーションでのみ異なります。 アマゾンアレクサとのアプリケーション。 その他、以下のすべての API は両方とも同じです。 アプリケーション。

トークンAPIをリフレッシュ

ログインまたはサインアップから収集されたトークンは、いくつかの後に期限が切れます 時間。 お問い合わせ トークンを再ログインするのではなく、以下の API を使用します。

リクエスト:

Httpの要求:

ポスト サーバ IP またはドメイン名/ビット/api/v1/auth/refresh/

パラメーター:

パラメータ バリューディテール
クライアントID 認証を作成するときに生成されるクライアント ID を貼り付ける
クライアント_secret 認証を作成するときに生成されるクライアントシークレットを貼り付ける
助成金の種類 refresh_token [refresh_token] の正確な単語を使用し、与えない ユーザーパスワード
更新履歴 ログインからトークンをリフレッシュするか、サインアップするか、または以前のリフレッシュ
応答:

成功について:

お問い合わせ
"bwapi-status": "成功",
「トークン」:「トークン」、
"refresh_token": "refreshトークンの値",
"expires_in": "36000",
"bwapi-status-reason": "successfulllogin"
"userid": "email_id",
お問い合わせ

失敗時:

お問い合わせ
"bwapi-status-reason": "無効な認証"
"bwapi-status": "fail"
お問い合わせ

認可ヘッダー

認証ヘッダーは認証を提供する方法です インフォメーション 以下のすべての API は、ユーザー固有のデータにアクセスします。 セッションを追加する トークンへ お問い合わせ セッショントークンは、リクエストヘッダの一部として設定する必要があります。 認証情報 Authorization ヘッダーの形式は :

認可:ベアラー < usertoken>

エラー応答 Authorization Header の使用について:

正規化ヘッダーが定義されていない場合 お問い合わせ
“detail”: “認証資格が提供されていない”
お問い合わせ
トークンが無効の場合
お問い合わせ
「詳細」:「無効トークン」
お問い合わせ

ログアウト API

この API は、アプリケーションが Bevywise IoT からログアウトするのに役立ちます。 プラットフォーム

方法:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/ビット/api/v1/auth/logout/

パラメーター:

パラメータ バリューディテール
パスワード 認証を作成するときに生成されるクライアント ID を貼り付ける
クライアント_secret 認証を作成するときに生成されるクライアントシークレットを貼り付ける
トークン ユーザートークン

応答:

成功について:

お問い合わせ
"bwapi-status": "成功",
"bwapi-status-reason": "ユーザがログアウト"
お問い合わせ

失敗時:

お問い合わせ
"detail": "認証資格が提供されていない"
お問い合わせ

Auth キー & Auth トークン生成

この API は Auth キー[mqtt ユーザ名] と Auth トークン[mqtt] を提供します。 パスワード センサーやデバイスを認証で接続します。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/devicesecurity/generatekey/

パラメーター:

パラメータ バリューディテール
デバイスタイプ エッジ/ゲートウェイ
プロトコル MQTT/HTTPの特長
アクセス 読む 書く/読む/書く
キー_desc コンテンツ
デバイスID デバイスID
デバイス名 デバイス名
keep_alive ディレクティブ 生き続ける(秒単位)

応答:

成功について:

お問い合わせ
"bwapi-status": "成功",
「データ」:
{"device_id": "デバイスのid",
"auth_key": "mqusername",
"auth_token": "mqpassword",
"description": "desc",
"権限": "権限"}
"userid": "email_id",
お問い合わせ

失敗時:

お問い合わせ
"bwapi-status-reason": "Reason",
"userid": "email_id",
"bwapi-status": "fail"
お問い合わせ

Auth キーの取得

この API は、生成された Auth キーを取得するのに役立ちます。

リクエスト:
Httpの要求:
正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/devicesecurity/get_auth_keys

応答:

デバイス接続時に:

お問い合わせ
"bwapi-status": "成功",
"userid": "email_id",
「データ」:

{"client_id": "クライアントのid",
"device_type": "Gateway",
"protocol": "MQTT",
"auth_key": "mqusername",
"auth_token": "mqpassword",
"description": "desc",
"権限": "権限"}
"created_at": "デバイスが作成される時間"
"description": "desc",
"connect_status": "active/inactive",
"device_img": "image",
"keep_alive":60、
「ステータス」:
お問い合わせ

失敗した時

お問い合わせ "bwapi-status-reason": "Reason", "userid": "email_id", "bwapi-status": "fail" お問い合わせ

プッシュFCM トークン API

この API は、通知をモバイルにプッシュするのに役立ちます アプリケーション FCM の統合を使って。

リクエスト:
スタッフ リクエスト:
正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/ビット/api/v1/auth/pushfcm/

パラメーター:

パラメータ バリューディテール
お知らせ_token fcmトークン値
デバイス ios または Android または web

注意: デバイスは、デバイスタイプに正確な単語を使用します。 のために 例えば、 デバイスタイプはアンドロイドで、デバイスとして「android」を使用します。

デバイスリストの取得

この API は、アクティブデバイスと非アクティブ接続デバイスの両方を取得できます。 リスト。

注意 : 設定ページ_no = -1 すべてのデバイスを取得するには

リクエスト:
スタッフ リクエスト:
正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/ビット/api/v1/デバイス/

パラメーター:

パラメータ バリューディテール
サイトマップ ページ数

応答:

デバイス接続時に:

お問い合わせ
"bwapi-status": "成功",
「データ」:

{"device_id": "デバイスのid",
"device_name": "デバイスの名前",
"last_active": "inactive",
"device_connected_time": "time"},
{"device_id": "デバイスのid",
"device_name": "デバイスの名前",
"last_active": "inactive",
"device_connected_time": 時間
お問い合わせ

失敗した時

Auth_keys が生成されていない場合

お問い合わせ
"bwapi-status-reason": 「エキスパートキーが見つかりません」
"userid": "email_id",
"bwapi-status": "fail",
お問い合わせ

デバイスが見つからなかったり、要求されたページでデータが見つからなかったりした場合

お問い合わせ
"bwapi-status": "fail",
"userid": "email_id",
"bwapi-status-reason": "No Device / Invalid Page",
お問い合わせ

サーバーエラーの場合

お問い合わせ
"bwapi-status-reason": "内部エラー",
"userid": "email_id",
"bwapi-status": "fail",
お問い合わせ

デバイスの詳細を取得する

この API は、デバイスの詳細を取得するのに役立ちます。

リクエスト:

Httpの要求:

正規化ヘッダーを追加:

ポスト サーバ IP またはドメイン名/bwiot/api/v1/devices/get_device_detail

パラメーター:

パラメータ バリューディテール
デバイスID id_of_the_device で詳細を知りたい

応答:

デバイス接続時に:

お問い合わせ
'bwapi-status': 'success',
'device_id': 'id のデバイス',
'device_name':'デバイスの名前 お問い合わせ
'will_topic': 'willtopic',
'will_message': 'willmessage',
'device_status': 'status',
'userid': 'email_id',
お問い合わせ

失敗時

お問い合わせ
"bwapi-status": "fail",
"bwapi-status-reason": "デバイスが見つかりません",
"userid": "email_id",
お問い合わせ

デバイスからイベントを受け取る

この API は、公開トピックのようなイベントのリストを提供します。 メッセージまたはペイロード 特定のデバイスから受け取った。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/devices/get_device_recv_detail

パラメーター:

パラメータ バリューディテール
サイトマップ 募集ページなし
デバイスID デバイスのid

応答:

お問い合わせ
'bwapi-status':'success' は、
'recv_data":

{'device_id":'id のデバイス",
'device_name':'デバイスの名',
'topic_name':'イベントが発生したトピックの名前,
「メッセージ」:'event"、
'timestamp':'イベントが発生したとき お問い合わせ お問い合わせ
お問い合わせ
'page_nav_data":
'next_page':true/false' は、
「total_pages」:「total page」,
'page_no':'現在のページ'},
'userid':'email_id' は、 お問い合わせ
お問い合わせ

失敗した時

お問い合わせ
"bwapi-status": "fail",
"bwapi-status-reason": "no_data_found",
"userid": "email_id",
お問い合わせ

デバイスで受信されたコマンドを取得する

この API は、購読されたトピックとメッセージのリストを提供します。 インフォメーション デバイス。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/devices/get_device_sent_detail

パラメーター:

パラメータ バリューディテール
サイトマップ 募集ページ
デバイスID デバイスのid

応答:

お問い合わせ
'bwapi-status':'success' は、
'sent_data':

{'device_id':'デバイスのid',
'device_name':'デバイスの名前 お問い合わせ
'topic_name':'イベントが発生したトピックの名前',
「メッセージ」 :'event',
'timestamp':'イベントの'},
'page_nav_data':
{'next_page':True/False は、
'total_pages':'total ページ お問い合わせ
'page_no': '現在のページ',
'userid': 'email_id' は、 お問い合わせ
お問い合わせ

失敗した時

お問い合わせ
"bwapi-status": "fail",
"bwapi-status-reason": "no_data_found",
「userid」:「email_id」
お問い合わせ

ダッシュボードの詳細はこちら

この API は、Bevywise IoT のダッシュボードから詳細を取得するのに役立ちます。 プラットフォーム

リクエスト:

Httpの要求:

正規化ヘッダーを追加:

お問い合わせ サーバ IP またはドメイン名/ビット/api/v1/ダッシュボード/

応答:

お問い合わせ
'bwapi-status': 'success',
'data':
{'active_client_count' で、 活動的な顧客のいいえ、
'total_client_count':クライアントの合計番号
'total_received_messages': 受け取ったメッセージの合計番号、
'sec_message_count': メッセージカウント,
'total_sent_message': 送信されたメッセージの合計 no.of
'recent_connections':

{'device_name': "デバイスの名前",
'device_id':'デバイスのid',
'device_time': 'device time'},
'recent_disconnects':
'recent_messages':

{'device_id': 'id のデバイス',
'topic_name': "トピックの名前",
'message_name': 'event',
'recv_time': "メッセージを受信した時刻"
お問い合わせ
'userid': 'email_id' は、 お問い合わせ
お問い合わせ

データが見つからない場合

お問い合わせ
"bwapi-status-reason": "no_data_found",
"userid": "email_id",
"bwapi-status": "fail",
お問い合わせ

サーバーエラーの場合:

お問い合わせ
"bwapi-status-reason": "内部エラー",
"userid": "email_id",
"bwapi-status": "fail",
お問い合わせ

アクティブなサブスクリプションを入手する

特定のアクティブなトピックの購読されたトピックのリストを提供します。

リクエスト

Httpリクエスト

正規化ヘッダーを追加

GEThttps://server IP またはドメイン名/bwiot/api/v1/ic/get_active_topics

パラメーター:

パラメータ バリューディテール
トピック トピックの名前

応答:

成功について

お問い合わせ
'bwapi-status': 'success',
'active_topics': ['topic1, トピック2'],
'userid': 'email_id' は、 お問い合わせ
お問い合わせ

失敗に

お問い合わせ
"bwapi-status": "fail",
"bwapi-status-reason": "no_data_found",
"userid": "email_id",
お問い合わせ

トピックに関連するクライアントのリストを取得する

この API は、サブスクリプションに基づいてクライアントのリストを提供します。 トピックス

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン 名前/bwiot/api/v1/ic/get_clients_related_to_the_topic

応答:

成功について

お問い合わせ
'bwapi-status': 'success',
「トピックの名前」
'クライアント':

{'device_id': 'id のデバイス',
'device_name': 'デバイスの名前'}
,
'userid': 'email_id' は、 お問い合わせ
お問い合わせ

失敗

変数は欠落しています:

{'bwapi-status': 'fail', 'bwapi-status-reason': 'Authorization Credentials が提供されていない'}

無効なトークン:

{'bwapi-status-reason':'無効なアクセストークン'、'bwapi-status':'fail'}

トピックにコマンドを送信

この API は、コマンドをトピックに送信するのに役立ちます。

リクエスト

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン 名前/bwiot/api/v1/ic/send_command_to_topic

パラメーター

パラメータ バリューディテール
トピック コマンドを送信したいトピックの名前。
コマンド コマンドまたはメッセージ
ソリューション

成功について

お問い合わせ
'bwapi-status': 'success',
'bwapi-status-reason':'command send',
'userid': 'email_id' は、 お問い合わせ
お問い合わせ

失敗時

お問い合わせ
'bwapi-status': 'fail',
'bwapi-status-reason': 'デバイスはアクティブ/見つかりません',
'userid': 'email_id' は、 お問い合わせ
お問い合わせ

デバイス用のアクティブなサブスクリプションを入手する

この API は、デバイスのアクティブなサブスクリプションを取得するのに役立ちます。

リクエスト
Httpの要求:
正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/ic/get_active_topics_for_this_device

パラメータ
パラメータ バリューディテール
デバイスID デバイスのid
ソリューション
成功について

お問い合わせ
'bwapi-status': 'success',
'topics': ['topic1'、'topic2']、
'userid': 'email_id' は、 お問い合わせ
お問い合わせ

失敗時

お問い合わせ
'bwapi-status': 'fail',
'bwapi-status-reason': 'No Topic Found'、
'userid': 'email_id' は、 お問い合わせ
お問い合わせ

コマンドをデバイスに送信する

この API を使用して、コマンドやメッセージを手動で送信できます。 デバイス 購読されたトピックに基づく。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/ic/send_command_to_device

パラメーター:

パラメータ バリューディテール
トピック デバイスの名称
コマンド コマンド
デバイスID デバイスのid

応答:

成功について

お問い合わせ
'bwapi-status': 'success',
'bwapi-status-reason':'command send',
'userid': 'email_id' は、 お問い合わせ
お問い合わせ

失敗した

お問い合わせ
"bwapi-status": "fail",
"bwapi-status-reason": 「デバイスがアクティブ/未発見されていない」
「userid」:「email_id」
お問い合わせ

デバイス名を編集する

この API は、接続された名前だけを変更または変更するために使われます。 デバイス。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/devices/edit_device_name

パラメーター:

パラメータ バリューディテール
new_device_name ディレクティブ 設定するデバイス名
デバイスID 名前を変更したいデバイスのID

応答:

成功について

お問い合わせ
'bwapi-status': 'success',
'device_name': 'デバイスの名前',
'userid': 'email_id' は、 お問い合わせ
お問い合わせ

失敗

お問い合わせ
"bwapi-status": "fail",
"bwapi-status-reason": "no_matching_device_id_found",
「userid」:「email_id」
お問い合わせ

デバイスの最終ステータスを取得する

受信したタイムスタンプのようなステータスを取得するAPIです。 デバイス 特定の装置のための状態、最後の受け取ったメッセージ等。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/devices/get_last_status_of_device

パラメーター:

パラメータ バリューディテール
デバイスID デバイスのid

応答:

成功について

お問い合わせ
'device_status': 'device status',
'device_id': 'id のデバイス',
'device_name': 'デバイスの名前',
'last_received_message': 'Last message receive',
'received_at': ' 最後のメッセージが受信された時刻',
'device_status': 'active/inactive',
'useri': 'email_id' は、 お問い合わせ
お問い合わせ

失敗した

お問い合わせ
"bwapi-status": "fail",
"bwapi-status-reason": "デバイスが見つかりません",
"userid": "email_id",
お問い合わせ

デバイスの削除

この API は、Bevywise IoT から特定のデバイスを削除するために使用されます。 プラットフォーム 永久に。

リクエスト:
Httpの要求:
正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/devices/delete_device/

パラメーター:

パラメータ バリューディテール
デバイスID デバイスのid

応答:

成功について

お問い合わせ
'bwapi-status': 'success',
'bwapi-status-reason': 'device_deleted',
'userid': 'email_id' は、 お問い合わせ
お問い合わせ

失敗した

お問い合わせ
"bwapi-status": "fail",
"bwapi-status-reason": "デバイスが見つかりません",
「userid」:「email_id」
お問い合わせ

カスタムデータの取得

この API は、すべてのアクティブデバイスに関する詳細情報を表示します。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト https://server IP またはドメイン名/bwiot/api/v1/devices_custom_data/

パラメーター:

パラメータ バリューディテール
サイトマップ -1

サンプル応答:

お問い合わせ
"next_page": 偽、
"userid": " [email protected]",
"bwapi-status": "成功",
「エラー」:「ノーエラー」、
「データ」: [
お問い合わせ
"last_received_message": "-",
"last_received_message_time": "-",
"last_active": "Inactive",
"active_topics": "

"soc1/onoff" は、
. .
,
"device_name": "Socket1",
"device_connected_time": "03-08-2018 11:00:54",
"device_id": "demo1/s1",
お問い合わせ
お問い合わせ
"last_received_message_time": "04-08-2018 16:57:47",
"last_active": "Active",
"active_topics": "

「mytopic」とは
. .
,
"device_name": 'test_device',
"device_connected_time": "04-08-2018 16:57:46",
"device_id": "publisherclient1",
"last_received_message": "hello I amパブリッシャー1"
お問い合わせ
,
"page_no":-1
お問い合わせ

デバイスグループを作成する

この API は、デバイスやマシンをグループ化するのに役立ちます。 担当部署

リクエスト::

Httpの要求::

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/admin/createDeviceGroup

パラメーター:

パラメータ バリューディテール
グループ名 グループ名
コンテンツ コンテンツ
デバイスグループ

この API は、特定のデバイスグループに関する詳細情報を取得するのに役立ちます

リクエスト::

Httpの要求::

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/admin/getDeviceGroup

デバイスグループを削除します。

この API は、作成または既存のデバイスグループを削除するのに役立ちます。

リクエスト::

Httpの要求::

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/admin/removeDeviceGroup

パラメーター:

パラメータ バリューディテール
グループ名 グループ名
デバイスをデバイスグループに追加する

この API は、特定のデバイスに新しいデバイスを追加するのに役立ちます グループ

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/admin/addDeviceToDeviceGroup

パラメーター:

パラメータ バリューディテール
グループ名 グループ名
デバイス プロフィール [「device1」「device2」...]
デバイスグループの詳細を取得する

この API は、デバイスのデバイスに関する詳細情報を取得するのに役立ちます インフォメーション デバイスグループ。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/ビット/api/v1/admin/getGroupDevices

パラメーター:

パラメータ バリューディテール
グループ名 グループ名
デバイスグループから削除

この API は、デバイスから特定のデバイスを削除するために使用できます。 グループ

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/ビット/api/v1/admin/removeGroupDevice

パラメーター:

パラメータ バリューディテール
グループ名 グループ名
デバイスID デバイスID
ユーザーを作成する

この API は、メール ID に基づいて新しいユーザーを作成するのに役立ちます お問い合わせ お問い合わせ 標準/管理として許可を割り当てます。

リクエスト:

Httpの要求:

正規化ヘッダーを追加:

ポスト サーバ IP またはドメイン名/ビット/api/v1/admin/createUser

パラメーター:

パラメータ バリューディテール
ユーザ権限 標準/管理
display_name を表示 お名前 (必須)
モバイル_no モバイルなし
パスワード メールID

応答:

成功について

お問い合わせ
'bwapi-status': 'success',
'bwapi-status-reason': 'ユーザは成功しました',
'userid': 'email_id' は、 お問い合わせ
お問い合わせ

失敗した時

お問い合わせ
'bwapi-status': 'failed',
'bwapi-status-reason': 'この時にリクエストを処理できません。 詳しくはこちら タイムタイム お問い合わせ
お問い合わせ

既に登録済みのメール ID を使用している場合

お問い合わせ
'bwapi-status': 'failed',
'bwapi-status-reason': 「メールアドレス登録済み」 お問い合わせ
お問い合わせ

ユーザーステータスチェンジャー(アクティブ/非アクティブ)

この API は、アクティブなユーザーの状態を変更するのに役立ちます。 または 反応する。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/admin/userStatusChanger

パラメーター:

パラメータ バリューディテール
パスワード メールID
ステータス アクティブ/非アクティブ

応答:

お問い合わせ
'bwapi-status': 'success',
'bwapi-status-reason':'ユーザーステータスが正常に変更されました',
'current-status': 'Active' の
お問い合わせ

失敗した時

お問い合わせ
'bwapi-status': 'failed',
'bwapi-status-reason':'ユーザーが見つかりません'
お問い合わせ

すべてのユーザーをゲット

この API は、追加したすべてのテナントについて詳細を取得するのに役立ちます。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/admin/get ユーザ名

応答:

お問い合わせ
'bwapi-status': 'success',
'data':

{'id': ユーザのid,
'email': 'email_id',
'login': ログイン日時',
'join': 'date & time', 'join', 'join' の日付と時刻
'status': 'active/inactive',
'name': 'username',
'contact': 'number',
'role': 'role' お問い合わせ
お問い合わせ

失敗した時

お問い合わせ
'bwapi-status': 'fail',
'bwapi-status-reason': 'reason',

'userid': 'email_id' は、 お問い合わせ
お問い合わせ

ユーザを削除

この API は、管理者から特定のユーザーを削除するのに役立ちます コンソール。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/admin/removeUser

パラメーター:

パラメータ バリューディテール
パスワード メールID

応答:

お問い合わせ
'bwapi-status': 'success',
'bwapi-status-reason':'Removed ユーザー お問い合わせ
お問い合わせ

失敗した時

お問い合わせ
'bwapi-status': 'failed',
'bwapi-status-reason':'ユーザーが見つかりません'
お問い合わせ

ユーザーの役割変更

ユーザーのロールをいつでも変更できます。 この API は、 変更点 お問い合わせ 管理者/標準としてユーザーの役割。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/admin/userRoleChange

パラメーター:

パラメータ バリューディテール
パスワード メールID
ログイン 管理/標準

応答:

制限が5の場合の成功:

お問い合わせ
'bwapi-status': 'success',
'permission': 'role お問い合わせ
お問い合わせ

失敗した時

お問い合わせ
'bwapi-status': 'failed',
'bwapi-status-reason':'無効なデータ'
お問い合わせ

ユーザーのデバイスグループを取得する

この API は、デバイスのグループの詳細を取得するのに役立ちます お問い合わせ 特定のユーザー。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/admin/getUserDeviceGroup

パラメーター:

パラメータ バリューディテール
パスワード メールID
デバイスグループをユーザに追加

この API は、デバイスグループをユーザに追加し、ヘルプを手助けします。 アサイン 新たに追加されたデバイスグループを表示または管理する許可。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/admin/addDeviceGroupToUser

パラメーター:

パラメータ バリューディテール
パスワード メールID
グループ名 グループ名
アクセス ビュー/管理
ユーザーからデバイスグループを削除

この API は、特定のデバイスグループを特定のデバイスグループから削除するのに役立ちます。 ユーザ。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/admin/removeDeviceGroup

パラメーター:

パラメータ バリューディテール
パスワード メールID
グループ名 グループ名
ユーザーグループ権限変更

この API は、ユーザの許可をいずれかに変更するのに役立ちます。 ニュース または 特定のデバイスグループを管理する

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/admin/groupPermissionChanger

パラメーター:

パラメータ バリューディテール
パスワード メールID
グループ名 グループ名
アクセス ビュー/管理
デバイス用のイベントルールを作成する

この API は、条件ベースのルールを作成して作成するのに役立ちます。 アラート 受信したトピックやメッセージに基づくイベント。

リクエスト::

Httpの要求::

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン 名前/bwiot/api/v1/rule_engine/create_event_rule/device_alert

リクエスト

お問い合わせ
'mq_client': 'device_id',
'mq_topic': 'event_topic',
'msg_chk_type': 'with_out_key',
'whole_set_condition' ディレクティブ: 'match_any',
'check_set':[
お問い合わせ
'compare_with': メッセージ,
'条件':
'値':20
お問い合わせ
お問い合わせ
'compare_with': 時間,
'条件': <
'時間':15、
'Minute': 7 の
お問い合わせ
. .
'response_message_type': "send_defined",
'forward_mq_message': "メッセージ",
'forward_mq_client': "device_id",
'forward_mq_topic': "topic",
お問い合わせ

ソリューション

お問い合わせ
"userid": "userId",
"bwapi-status-reason": "rule_added",
"bwapi-status": "成功",
お問い合わせ

メールイベントルールを作成する

この API は、ルールやアラートメッセージをメールとして送信するのに役立ちます お問い合わせ 指定されたメール ID。

リクエスト:
Httpの要求:
正規化ヘッダーを追加

ポスト サーバ IP またはドメイン 名前/bwiot/api/v1/rule_engine/create_event_rule/mail_alert

リクエスト

お問い合わせ
'mq_client': 'device_id',
'mq_topic': 'event_topic',
'msg_chk_type': 'with_out_key',
'whole_set_condition' ディレクティブ: 'match_any',
'check_set':[
お問い合わせ
'compare_with': メッセージ,
'条件':
'値':20
お問い合わせ
お問い合わせ
'compare_with': 時間,
'条件': <
'時間':15、
'Minute': 7 の
お問い合わせ
. .
'response_message_type': "attach_meta",
'forwarding_mail': "mail_id",
'forwarding_subject': "subject"
, 'forwarding_body': "message",
お問い合わせ

ソリューション

お問い合わせ
"userid": "userId",
"bwapi-status-reason": "rule_added",
"bwapi-status": "成功",
お問い合わせ

デバイス用のWebsocketイベントルールを作成する

この API は、デバイスのイベントルールを作成して、デバイスをプッシュするのに役立ちます。 アラート 通知としてメッセージ。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン 名前/bwiot/api/v1/rule_engine/create_event_rule/ws_alert

リクエスト

お問い合わせ
'mq_client': 'device_id',
'mq_topic': 'event_topic',
'msg_chk_type': 'with_out_key' は、 お問い合わせ
, 'whole_set_condition': 'match_any' は、 お問い合わせ
, 'check_set':[
お問い合わせ
'compare_with': メッセージ,
'条件':
'値':20
お問い合わせ
お問い合わせ
'compare_with': 時間,
'条件': <
'時間':15、
'分': 7、
お問い合わせ
. .
'notification_title': "title",
'notification_body': "message",
お問い合わせ

ソリューション

お問い合わせ
"userid": "userId",
"bwapi-status-reason": "rule_added",
"bwapi-status": "成功",
お問い合わせ

デバイス用のFCMイベントルールを作成する

この API は、デバイスのイベントルールを作成して、デバイスをプッシュするのに役立ちます。 データデータ として FCMトークンに基づくアンドロイドまたはiosアプリへの通知。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン 名前/bwiot/api/v1/rule_engine/create_event_rule/fcm_alert

リクエスト:

お問い合わせ
'mq_client': 'device_id',
'mq_topic': 'event_topic',
'msg_chk_type': 'with_out_key',
'whole_set_condition' ディレクティブ: 'match_any',
'check_set':[
お問い合わせ
'compare_with': メッセージ,
'条件':

'値':20
お問い合わせ

お問い合わせ
'compare_with': 時間,
'条件': <
'時間':15、
'分': 7、
お問い合わせ
. .
'notification_title': "title",
'notification_body': "message",
お問い合わせ

応答:

お問い合わせ "userid": "userId",
"bwapi-status-reason": "rule_added",
"bwapi-status": "成功",
お問い合わせ

タイマールールを作成する

このAPIは、データをデバイスに送信するためのタイマールールを作成するのに役立ちます お問い合わせ は、 特定の時間または特定の時間間隔で。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン 名前/bwiot/api/v1/rule_engine/create_timer_rule/device_alert

リクエスト

お問い合わせ
'device_id': 'device_id',
「トピック」:「トピック」、
'メッセージ':'メッセージ',
'hour': '0-24',
'分': '0-59',
'startdaterange': mm/dd/yyy,
'enddaterange': mm/dd/yyy、
お問い合わせ

ソリューション

お問い合わせ
"userid": "userId",
"bwapi-status-reason": "rule_added",
"bwapi-status": "成功",
お問い合わせ

ルールの取得

この API は、作成したすべてのルールのリストを取得するのに役立ちます。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト https://server IP またはドメイン名/bwiot/api/v1/rule_engine/get_rule_list

リクエスト

お問い合わせ 'page_no': 'number', お問い合わせ

ソリューション

お問い合わせ
「ルール」:[
お問い合わせ
「フォワード」: お問い合わせ
"reaction_method": "send_via_mqtt",
"mq_client": "device_id",
"response_message_type": "send_defined",
"mq_topic": "トピック",
"mq_message": "メッセージ",
お問い合わせ
「時間」:「15586906980」、
"id": "105"、
"イベント": お問い合わせ
"time_check_set":[

お問い合わせ
<>
5月15日
7月7日
. .
. .
"whole_set_condition": "match_any",
"mq_topic": "event_topic",
"check_set": [],
"msg_chk_type": "with_out_key",
"mq_client": "device_id",
お問い合わせ
お問い合わせ
お問い合わせ
"forward": "
"reaction_method": "send_via_ws",

"notification_title": "title",
"notification_body": "メッセージ",
お問い合わせ
「時間」:「1558693863847」
"id": "108",
"イベント": お問い合わせ
"time_check_set":[

お問い合わせ
<>
5月15日
7月7日
. .
. .
"whole_set_condition": "match_any",

"mq_topic": "event_topic",
「check_set」: [

「INCOMING_MSG」は、
">、
2018年10月20日
. .

「INCOMING_MSG」は、
お問い合わせ
15 日
. .
,
"msg_chk_type": "with_out_key",
"mq_client": "device_id",
お問い合わせ
お問い合わせ
お問い合わせ
"msg_chk_type": お問い合わせ
"reaction_method": "send_via_fcm",
"notification_title": "title",
"notification_body": "メッセージ",
お問い合わせ
「時間」:「1558694345964」
"id": "109"、"
"イベント": お問い合わせ
"time_check_set":[

お問い合わせ
<>
5月15日

7月7日
. .
. .
"whole_set_condition": "match_any",
"mq_topic": "event_topic",
「check_set」: [

「INCOMING_MSG」は、
">、
2018年10月20日
. .

「INCOMING_MSG」は、
お問い合わせ
15 日
. .
,
"msg_chk_type": "with_out_key",
"mq_client": "device_id",
お問い合わせ

お問い合わせ
. .
"page_nav_data": お問い合わせ
"next_page": 偽
"total_pages":1、

"page_no": 0
お問い合わせ
"user_id": "user_id",
"bwapi-status": "成功"
,

ルールの削除

この API は、作成したルールを削除するのに役立ちます。

Httpの要求:

正規化ヘッダーを追加

ポスト https://server IP またはドメイン名/bwiot/api/v1/rule_engine/delete_rule

リクエスト

お問い合わせ 'rule_id': 'numeric', お問い合わせ

ソリューション

お問い合わせ
"bwapi-status": "成功",
"bwapi-status-reason": "削除されたルール",
"userid": "userid"
お問い合わせ

デバイス管理

サブデバイスを表示する

この API は、サブデバイスのリストを取得するのに役立ちます

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/devicesecurity/show_subdevices

パラメーター:

パラメータ バリュー
ゲートウェイ_device_id ゲートウェイ装置 id

成功について

お問い合わせ
「bwapi-status」:「成功」、
'userid':'email_id',
「データ」:

{'subdevice_id':'subdeviceのid',
'connect_status': 0
. .
お問い合わせ

ソリューション

お問い合わせ
「bwapi-status」:「fail」、
「bwapi-status-reason」:「no_data_found」、
'userid': 'email_id' の . .
お問い合わせ

サブデバイスの詳細を表示する

この API は、サブデバイスの詳細を取得するのに役立ちます

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン 名前/bwiot/api/v1/devicesecurity/show_subdevice_details

パラメーター:

パラメータ バリュー
サブデバイス_id サブデバイスID

成功事例

お問い合わせ
「bwapi-status」:「成功」、
'userid':'email_id',
「データ」:

{'sub_device_id':'subdeviceのid',
'client_name': クライアントの名前
'command_topics': ['topic1', ‘topic2’, ‘topic3’],
「event_topics」: ['eventtopic1', ‘eventtopic2’, ‘eventtopic3’}
. .
お問い合わせ お問い合わせ

ソリューション

お問い合わせ
「bwapi-status」:「fail」、
「bwapi-status-reason」:「no_data_found」、
'userid': 'email_id' の . .
お問い合わせ

サブデバイスの更新

この API は、サブデバイスを更新するのに役立ちます。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/devicesecurity/update_subdevice

パラメーター:

パラメータ バリュー
サブデバイス_id サブデバイスID
サブデバイス名 サブデバイス名
コマンド_topic サブスクリプショントピック
イベント_トピック 公開トピック

成功について

お問い合わせ
「bwapi-status」:「成功」、
'userid': 'email_id' の . .
お問い合わせ

ソリューション

お問い合わせ
「bwapi-status」:「fail」、
「bwapi-status-reason」 : 「リーソン」、
'userid': 'email_id' の . .
お問い合わせ

サブデバイスを追加

この API は、サブデバイスを追加するのに役立ちます

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/bwiot/api/v1/devicesecurity/add_subdevices

パラメーター:

パラメータ バリュー
サブデバイス_id サブデバイスID
サブデバイス名 サブデバイス名
コマンド_topic サブスクリプショントピック
イベント_トピック 公開トピック

成功事例

お問い合わせ
「bwapi-status」:「成功」、
'userid': 'email_id' の . .
お問い合わせ

ソリューション

お問い合わせ
「bwapi-status」:「fail」、
「bwapi-status-reason」 : 「内部エラー」,
'userid': 'email_id' の . .
お問い合わせ

サブデバイスを削除します。

この API は、サブデバイスを削除するのに役立ちます

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン名/ビット/api/v1/devicesecurity/delete_subdevices

パラメーター:

パラメータ バリュー
サブデバイス_id サブデバイスID

成功について

お問い合わせ
「bwapi-status」:「成功」、
'userid': 'email_id' の . .
お問い合わせ

ソリューション

お問い合わせ
「bwapi-status」:「fail」、
「bwapi-status-reason」 : 「内部エラー」,
'userid': 'email_id' の . .
お問い合わせ

クライアント ID の独自性を確認する

この API は、クライアント ID の独自性を確認するのに役立ちます。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン 名前/bwiot/api/v1/devicesecurity/check_uniqueness_of_clientid

パラメーター:

パラメータ バリュー
デバイス_id_chk クライアント ID

成功について

お問い合わせ
「bwapi-status」:「成功」、
「bwapi-status-reason」: 「クライアントIDが利用可能」
'userid': 'email_id' の . .
お問い合わせ

ソリューション

お問い合わせ
「bwapi-status」:「fail」、
「bwapi-status-reason」: 「クライアントIDは既に存在しています」、
'userid':'email_id',
お問い合わせ

アクセス変更 キーステータス

この API は、アクセスキーのステータスを変更するのに役立ちます。

リクエスト:

Httpの要求:

正規化ヘッダーを追加

ポスト サーバ IP またはドメイン 名前/bwiot/api/v1/devicesecurity/change_access_key_status

パラメーター:

パラメータ バリュー
アクセスキー auth キー
デバイスID デバイスID
文字列_status アクティブ/非アクティブ

成功について

お問い合わせ
「bwapi-status」:「成功」、
'userid':'email_id',
'new_status':'active' は、
お問い合わせ

失敗した時

お問い合わせ
「bwapi-status」:「fail」、
「bwapi-status-reason」:「内部エラー」、
'userid': 'email_id' の . .
お問い合わせ