Bevywise Enterprise IoT Platform API Dokumentation

Einleitung

Die in diesem Dokument vorgestellte REST API kann verwendet werden, um zu kommunizieren mit Bevywise IoT-Plattform zur Erstellung einer mobilen Anwendung für Ihre IoT-Lösung oder für Integration Bevywise IoT Platfom mit Amazon Alexa oder anderen fortschrittlichen Anwendungen.

Voraussetzung für Bevywise IoT Platform

Bevywise IoT Platform unterstützt zwei Arten von Authentifizierung Mechanismus, der Benutzer können unser IoT nutzen Plattform zur Integration mit Mobile-Anwendung und mit AlexaAmazon oder andere fortgeschrittene Anwendungen.

Sobald Sie unser IoT einrichten Plattform in Ihrer Cloud-Umgebung, Anmelden die Admin-Konsole und gehen Sie zu unten URL, um die Authentifizierung basierend auf Ihrer Anwendung einzurichten.

https://server IP oder Domain Name/o/Anwendungen/

Typ 1: Authentication für direkte Anmeldung

Wenn Sie Ihre mobile Anwendung mit Benutzername anmelden möchten und Passwort vergessen? direkt über unsere API, füllen Sie die Details wie folgt und speichern.

Name: < Name der Anmeldung>
Client id: < es wird automatisch erstellt nicht ändern es>
Client Geheimnis: < es wird automatisch erstellt werden nicht ändern es>
Kundentyp: Vertraulichkeit
Zulassungszuschussart: Passwort des Ressourceninhabers
Redirect urls: < Leave it leer>

Sobald Sie die Konfiguration abgeschlossen haben, erhalten Sie Client-ID, Client geheim, Kundentyp und Zulassungszuschuss. Machen Sie ein Backup der Details für weitere Verwendung.

Typ 2: Authentication für Amazon Alexa Skillset oder andere Anwendungsbereich

Diese Authentifizierung basiert auf der OAUTH2 Authentication, die verwendet für eine Anwendung mit „OAUTH2 Authentication Code Grant Flow“[ verwendet in Amazon Alexa Geschick gesetzt oder Google-Hilfe]. Füllen Sie die Details wie folgt und speichern Sie sie.

Name: < Name der Anmeldung>
Client id: < es wird automatisch erstellt nicht ändern es>
Client Geheimnis: < es wird automatisch erstellt werden nicht ändern es>
Kundentyp: Vertraulichkeit
Zulassungszuschussart: Zulassungscode
Redirect urls: < redirect urls the alexa want>

Sobald Sie die Konfiguration abgeschlossen haben, erhalten Sie Client-ID, Client geheim, Kundentyp und Zulassungszuschuss. Machen Sie ein Backup der Details für weitere Verwendung.

Anmelden API

Diese API hilft Ihnen, ein neues Konto in Bevywise IoT zu erstellen Plattform.

Anfrage:

POST https://server IP oder Domain Name/Bwiot/api/v1/auth/signup/

Parameter:

PARAMETER	VALUE DETAIL
Benutzername	E-Mail-ID des Benutzers
Passwort vergessen?	alle Passwort-String
Kundenbetreuung	fügen Sie die Client-ID ein, die beim Erstellen von Authentifizierung erzeugt wird
Client_secret	fügen Sie das Client-Geheimnis ein, das beim Erstellen von Authentifizierung erzeugt wird
Grant_type	Passwort [verwenden Sie das genaue Wort “Passwort” und geben Sie dem Benutzer nicht Passwort:

Antwort:

Auf Erfolg:

{\cHFFFF}
"bwapi-status": "Erfolg",
"userid": "email_id",
"Token": "Token",
"expires_in": "36000",
"refresh_token": "das Erfrischungstoken",
"bwapi-status-reason": "successfullsignup"
}

Auf der Flucht:

{\cHFFFF}
"bwapi-status": "fail"
Nachricht': 'Account konnte nicht mit empfangenen Daten erstellt werden
{"username": ["Ein Benutzer mit diesem Benutzernamen existiert bereits."]} '
}

Login API

Diese API hilft Ihnen, sich in der Bevywise IoT Platform anzumelden.

Typ 1:

Token für normale oder direkte Anmeldung zur Anwendung mit Benutzername und Passwort vergessen?

Anfrage:

POST https://server IP oder Domainname/bwiot/api/v1/auth/login/

Parameter:

PARAMETER	VALUE DETAIL
Benutzername	E-Mail-ID des Benutzers
Passwort vergessen?	alle Passwort-String
Kundenbetreuung	fügen Sie die Client-ID ein, die beim Erstellen von Authentifizierung erzeugt wird
Client_secret	fügen Sie das Client-Geheimnis ein, das beim Erstellen von Authentifizierung erzeugt wird
Grant_type	Passwort [verwenden Sie das genaue Wort “Passwort” und geben Sie dem Benutzer nicht Passwort:

Antwort:

Auf Erfolg:

{\cHFFFF}
"bwapi-status": "Erfolg",
"Token": "Token",
"refresh_token": "refresh token value",
"expires_in": "36000",
"bwapi-status-reason": "successfulllogin"
"userid": "email_id",
}

Auf der Flucht:

{\cHFFFF}
"bwapi-status-reason": "Invalid Credentials",
"bwapi-status": "fail"
}

Typ 2

Verwenden Sie die nach der Authentication generierten Details Bevywise IoT Plattform zu integrieren Bevywise IoT Platform zu Ihrem alexa Skillset Server oder anderen Server, der hat oauth2 Autorisierungscode-Flow.
Geben Sie die Details basierend auf den folgenden Details für andere notwendige URLs und Beispiel in Oauth2 Autorisierungscode-Flow

Authorization Grant Type: Auth Code Grant
Authorization URL: https://devicemanager.bevywise.com/o/authorize/
Access Token URL: https://devicemanager.bevywise.com/o/token/
Client-ID: Kopieren und Einfügen der Client-ID aus Authentication
Client Secret: kopieren und fügen Sie das Client Secret erstellt von Authentication
Typ 2
Client Authentifizierung Schema: Http Basic
Anwendungsbereich: Schreiben lesen

Hinweis: Nur die Login-API muss für die normale Anwendung und die Anwendung mit Amazon Alexa. Andere als dies, alle folgenden APIs sind für beide gleich Anwendungen.

Refresh Token API

Der Token aus dem Login oder dem Anmelden endet nach einigen Zeit. Zu aktualisieren Sie das Token verwenden Sie die folgende API anstelle von re-login.

Anfrage:

POST https://server IP oder Domainname/bwiot/api/v1/auth/refresh/

Parameter:

PARAMETER	VALUE DETAIL
Kundenbetreuung	fügen Sie die Client-ID ein, die beim Erstellen von Authentifizierung erzeugt wird
Client_secret	fügen Sie das Client-Geheimnis ein, das beim Erstellen von Authentifizierung erzeugt wird
Grant_type	update_token [verwenden Sie das genaue Wort “refresh_token” und geben Sie das nicht Benutzerkennwort:
Auf den Wunschzettel	Erfrischen Sie Token aus dem Login oder melden Sie sich oder vorheriges Erfrischen

Antwort:

Auf Erfolg:

{\cHFFFF}
"bwapi-status": "Erfolg",
"Token": "Token",
"refresh_token": "refresh token value",
"expires_in": "36000",
"bwapi-status-reason": "successfulllogin"
"userid": "email_id",
}

Auf der Flucht:

{\cHFFFF}
"bwapi-status-reason": "Invalid Credentials",
"bwapi-status": "fail"
}

Autorisierung Header

Authorization header ist die Methode der Authentifizierung Informationen. Alle untenstehenden APIs greifen auf Daten zu, die für einen Benutzer spezifisch sind. Wir müssen die Sitzung hinzufügen token to Alle. Der Sitzungstoken sollte als Teil des Antrags Header gesetzt werden, um Authentifizierungsinformationen. Das Format des Authorization header ist:

Autorisierung: Bearer < usertoken>

Fehlerantworten Bei der Verwendung von Authorization Header:

Wenn Autorisierungskopf nicht definiert ist {\cHFFFF}
„detail“: „Authentication-Anmeldeinformationen wurden nicht bereitgestellt. „
}
Wenn Token ungültig ist
{\cHFFFF}
„detail“: „Ungültiger Token. „
}

Logout API

Diese API hilft Ihrer Anwendung, sich vom Bevywise IoT abzumelden Plattform

Methode:

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/auth/logout/

Parameter :

PARAMETER	VALUE DETAILS
Benutzername	fügen Sie die Client-ID ein, die beim Erstellen von Authentifizierung erzeugt wird
Client_secret	fügen Sie das Client-Geheimnis ein, das beim Erstellen von Authentifizierung erzeugt wird
Token	Benutzerhandbuch

Antwort:

Auf Erfolg:

{\cHFFFF}
"bwapi-status": "Erfolg",
"bwapi-status-reason": "Benutzer angemeldet"
}

Auf der Flucht:

{\cHFFFF}
"detail": "Authentication Credentials wurden nicht bereitgestellt"
}

Auth Key & Auth Token Generation

Diese API bietet Auth-Taste[mqt-Benutzername] und Auth-Token[mqtt Passwort] to Ihren Sensor oder Gerät mit Authentifizierung verbinden.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/devicesecurity/genratekey/

Parameter :

PARAMETER	VALUE DETAILS
Gerät_Typ	Rand/Gateway
Protokoll	MQTT/HTTP
Berechtigungen	Schreiben / Lesen / Schreiben
Schlüsselwort	Beschreibung
Gerät_id	Gerätid
Artikelname	Name des Geräts
weiterlesen	Leben erhalten (in Sekunden)

Antwort:

Auf Erfolg:

{\cHFFFF}
"bwapi-status": "Erfolg",
"Daten":
{"device_id": "id of the device",
"auth_key": "mqusername",
"auth_token": "mqpassword",
"Beschreibung": "desc",
"Befreiungen": "Befreiung"}
"userid": "email_id",
}

Auf der Flucht:

{\cHFFFF}
"bwapi-status-reason": "Reason",
"userid": "email_id",
"bwapi-status": "fail"
}

Auth Keys bekommen

Diese API hilft, die generierten Auth Keys zu erhalten.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/devicesecurity/get_auth_keys

Antwort:

Wenn Gerät angeschlossen:

{\cHFFFF}
"bwapi-status": "Erfolg",
"userid": "email_id",
"Daten":
(
{"client_id": "id of the client",
"device_type": "Gateway",
"Protocol": "MQTT",
"auth_key": "mqusername",
"auth_token": "mqpassword",
"Beschreibung": "desc",
"Befreiungen": "Befreiung"}
"created_at": "Zeit, an der das Gerät erstellt wird",
"Beschreibung": "desc",
"connect_status": "aktiv/inaktiv",
"device_img": "Bild",
"keep_alive": 60,
"Status": 0)
}

Auf der Flucht

{\cHFFFF} "bwapi-status-reason": "Reason", "userid": "email_id", "bwapi-status": "fail" }

Push FCM Token API

Diese API hilft Ihnen, die Benachrichtigung auf Ihr Handy zu drücken Anwendungsbereich mit FCM-Integration.

Anfrage:

HTTP Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/auth/pushfcm/

Parameter :

PARAMETER	VALUE DETAILS
Benachrichtigung_token	fcm Tokenwert
Vorrichtung	ios oder android oder web

Hinweis: Für das Gerät verwenden Sie das genaue Wort für Ihren Gerätetyp. Für Beispiel, wenn Ihr Gerätetyp ist Android, dann verwenden Sie “Android” als Gerät.

Geräteliste hinzufügen

Diese API hilft Ihnen, das aktive und inaktive angeschlossene Gerät zu erhalten Liste.

Anmerkung : set page_no = -1 um alle Geräte zu erhalten

Anfrage:

HTTP Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/devices/

Parameter :

PARAMETER	VALUE DETAIL
Seite_no	Seite nicht

Antwort:

Wenn Gerät angeschlossen:

{\cHFFFF}
"bwapi-status": "Erfolg",
"Daten":
(
{"device_id": "id of the device",
"device_name": "Name des Geräts",
"last_active": "inaktiv",
"device_connected_time": "time"},
{"device_id": "id of the device",
"device_name": "Name des Geräts",
"last_active": "inaktiv",
"device_connected_time": Zeit
}

Auf der Flucht

Wenn Auth_keys nicht generiert

{\cHFFFF}
"bwapi-status-reason": "Gerät Auth Keys nicht gefunden",
"userid": "email_id",
"bwapi-status": "fail",
}

Wenn kein Gerät gefunden wurde oder keine Daten gefunden wurden, die auf der angeforderten Seite nicht gefunden wurden

{\cHFFFF}
"bwapi-status": "fail",
"userid": "email_id",
"bwapi-status-reason": "No Device / Invalid Page",
}

Wenn ein Serverfehler

{\cHFFFF}
"bwapi-status-reason": "Internal Error",
"userid": "email_id",
"bwapi-status": "fail",
}

Informationen zum Gerät

Diese API hilft Ihnen, das Detail des Geräts zu erhalten.

Anfrage:

Autorisierung Header hinzufügen:

POST https://server IP oder Domainname/bwiot/api/v1/devices/get_device_detail

Parameter :

PARAMETER	VALUE DETAIL
Gerät_id	id_of_the_device, für die Sie Details wissen möchten

Antwort:

Wenn Gerät angeschlossen:

{\cHFFFF}
'bwapi-Status': 'Erfolg'
'device_id': 'id of the device',
'device_name':'Name des Geräts '
'will_topic': 'willtopic',
'will_message': 'willmessage',
'device_status': 'status',
'userid': 'email_id',
}

Auf der Flucht

{\cHFFFF}
"bwapi-status": "fail",
"bwapi-status-reason": "Gerät nicht gefunden",
"userid": "email_id",
}

Events von Device erhalten

Diese API bietet die Liste der Ereignisse wie das Publikationsthema, Nachricht oder Payload von einer bestimmten Vorrichtung aufgenommen.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/devices/get_device_recv_detail

Parameter:

PARAMETER	VALUE DETAIL
Seite_no	Seite nicht gefunden
Gerät_id	id der Vorrichtung

Antwort:

{\cHFFFF}
'bwapi-Status':'erfolg',
'recv_data':
(
('device_id':'id of the device'',
'device_name': 'Name des Geräts'',
'topic_name': 'Name des Themas, das das Ereignis aufgetreten ist',
"Nachricht" : "Veranstaltung"
'timestamp'':'time the event ' '
},
'page_nav_data':
'next_page':true/false',
'total_pages': 'totalpages',
'page_no'':'current page'},
'userid':'email_id '
}

Auf der Flucht

(STÖHNT)
"bwapi-status": "fail",
"bwapi-status-reason": "no_data_found",
"userid": "email_id",
}

Befehle in Gerät empfangen

Diese API bietet die Liste der abonnierten Themen und Nachrichten eines insbesondere Gerät.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/devices/get_device_sent_detail

Parameter :

PARAMETER	VALUE DETAIL
Seite_no	Seite nicht gefunden
Gerät_id	id der Vorrichtung

Antwort:

{\cHFFFF}
'bwapi-Status':'erfolg',
'sent_data':
(
('device_id':'id of the device',
'device_name':'Name des Geräts '
'topic_name': 'Name des Themas, das das Ereignis aufgetreten ist',
"Nachricht" : "Ereignis",
'Zeitstempel': 'Zeit des Ereignisses aufgetreten'},
'page_nav_data':
{'next_page':True/False,
'total_pages':'totale Seiten '
'page_no': 'current page',
'userid': 'email_id '
}

Auf der Flucht

{\cHFFFF}
"bwapi-status": "fail",
"bwapi-status-reason": "no_data_found",
"userid": "email_id"
}

Dashboard Details

Diese API hilft Ihnen, Details vom Dashboard von Bevywise IoT zu erhalten Plattform.

Anfrage:

Autorisierung Header hinzufügen:

GET https://server IP oder Domainname/bwiot/api/v1/dashboard/

Antwort:

{\cHFFFF}
'bwapi-Status': 'Erfolg'
'Daten':
{'active_client_count': Anzahl der aktiven Kunden,
'total_client_count': Gesamtzahl der Kunden,
'total_received_messages': Gesamtzahl der empfangenen Nachrichten,
'sec_message_count': Nachrichtenzählung,
'total_sent_message': Gesamtzahl der gesendeten Nachrichten,
'recent_connections':
(
{'device_name': "Name des Geräts",
'device_id': 'id of the device',
'device_time': 'device time'},
'recent_disconnects':
'recent_messages':
(
{'device_id': 'id of the device',
'topic_name': "Name des Themas",
'message_name': 'event',
'recv_time': "Zeit, zu dem die Nachricht empfangen wurde"
}
'userid': 'email_id '
}

Wenn keine Daten gefunden werden

{\cHFFFF}
"bwapi-status-reason": "no_data_found",
"userid": "email_id",
"bwapi-status": "fail",
}

Wenn ein Serverfehler :

{\cHFFFF}
"bwapi-status-reason": "Internal Error",
"userid": "email_id",
"bwapi-status": "fail",
}

Aktives Abonnement erhalten

Geben Sie eine Liste der abonnierten Themen für bestimmte aktive Themen an.

Anfrage

Http Anfrage

Authorization Header hinzufügen

GEThttps://server IP oder Domainname/bwiot/api/v1/ic/get_active_topics

Parameter :

PARAMETER	VALUE DETAIL
Thema	Name des Themas

Antwort:

Auf Erfolg

{\cHFFFF}
'bwapi-Status': 'Erfolg'
'active_topics': ['topic1, topic2']
'userid': 'email_id '
}

ON Failing

{\cHFFFF}
"bwapi-status": "fail",
"bwapi-status-reason": "no_data_found",
"userid": "email_id",
}

Liste der Clients mit einem Thema erhalten

Diese API bietet eine Liste von Clients basierend auf dem abonnierten Themen..

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domain Name/Bwiot/api/v1/ic/get_clients_ related_to_the_topic

Antwort:

Auf Erfolg

{\cHFFFF}
'bwapi-Status': 'Erfolg'
'topisch': 'Name des Themas',
„Clients":
(
{'device_id': 'id of the device',
'device_name': 'Name des Geräts'}
,
'userid': 'email_id '
}

Ausfall

Parameter fehlen:

'bwapi-Status': 'fail', 'bwapi-status-reason': 'Authorization Credentials not available'}

Invalid Token:

{'bwapi-status-reason': 'Invalid Access Token', 'bwapi-status': 'fail'}

Befehl an ein Thema senden

Diese API hilft Ihnen, Befehl an ein Thema zu senden.

Anfrage

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domain Name/Bwiot/api/v1/ic/send_command_to_top

Parameter

PARAMETER	VALUE DETAIL
Thema	Name des Themas, für das Sie Befehl senden möchten.
Befehl	Befehl oder Nachricht

Antwort

Auf Erfolg

{\cHFFFF}
'bwapi-Status': 'Erfolg'
'bwapi-status-reason': 'Befehl senden',
'userid': 'email_id '
}

Auf der Flucht

{\cHFFFF}
'bwapi-Status': 'fail',
'bwapi-status-reason': 'Gerät ist nicht aktiv/nicht gefunden',
'userid': 'email_id '
}

Aktive Abonnements für ein Gerät erhalten

Diese API hilft Ihnen, die aktiven Abonnements eines Geräts zu erhalten.

Anfrage

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/ic/get_active_topics_for_this_device

Parameter

PARAMETER	VALUE DETAIL
Gerät_id	id der Vorrichtung

Antwort

Auf Erfolg

{\cHFFFF}
'bwapi-Status': 'Erfolg'
"Topik": ['topic1', 'topic2'],
'userid': 'email_id '
}

Auf der Flucht

(STÖHNT)
'bwapi-Status': 'fail',
'bwapi-status-reason': 'No Topic Found',
'userid': 'email_id'
}

Befehl an ein Gerät senden

Mit dieser API können Sie manuell einen Befehl oder eine Nachricht an die Vorrichtung basierend auf dem abonnierten Thema.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/ic/send_command_to_device

Parameter :

PARAMETER	VALUE DETAIL
Thema	Name des Geräts
Befehl	Befehl
Gerät_id	id der Vorrichtung

Antwort:

Auf Erfolg

{\cHFFFF}
'bwapi-Status': 'Erfolg'
'bwapi-status-reason':'command send',
'userid': 'email_id '
}

Versäumt

{\cHFFFF}
"bwapi-status": "fail",
"bwapi-status-reason": "Gerät ist nicht aktiv/nicht gefunden",
"userid": "email_id"
}

Gerätename bearbeiten

Diese API wird verwendet, um nur den Namen des angeschlossenen zu ändern oder zu ändern Gerät.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/devices/edit_device_name

Parameter :

PARAMETER	VALUE DETAIL
neu_device_name	Gerätename zum Einstellen
Gerät_id	ID des Geräts, für das Sie den Namen ändern möchten

Antwort:

Auf Erfolg

{\cHFFFF}
'bwapi-Status': 'Erfolg'
'device_name': 'Name des Geräts',
'userid': 'email_id '
}

Ausfall

{\cHFFFF}
"bwapi-status": "fail",
"bwapi-status-reason": "no_matching_device_id_found",
"userid": "email_id"
}

Erhalten Sie den letzten Status eines Geräts

Diese API verwendet, um einen Status wie Nachricht erhalten Zeitstempel, Vorrichtung Status, letzte empfangene Nachricht usw. für ein bestimmtes Gerät.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/devices/get_last_status_of_device

Parameter :

PARAMETER	VALUE DETAIL
Gerät_id	id der Vorrichtung

Antwort:

Auf Erfolg

{\cHFFFF}
'device_status': 'device status',
'device_id': 'id of the device',
'device_name': 'Name des Geräts',
'last_received_message': 'letzte Nachricht empfangen',
'received_at': 'Zeit, zu der die letzte Nachricht empfangen wird',
'device_status': 'aktiv/inaktiv',
'useri': 'email_id '
}

Versäumt

{\cHFFFF}
"bwapi-status": "fail",
"bwapi-status-reason": "Gerät nicht gefunden",
"userid": "email_id",
}

Löschen Gerät

Diese API wird verwendet, um ein bestimmtes Gerät von Bevywise IoT zu löschen Plattform dauerhaft.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/devices/delete_device/

Parameter :

PARAMETER	VALUE DETAIL
Gerät_id	id der Vorrichtung

Antwort:

Auf Erfolg

{\cHFFFF}
'bwapi-Status': 'Erfolg'
'bwapi-status-reason': 'device_deleted',
'userid': 'email_id '
}

Versäumt

{\cHFFFF}
"bwapi-status": "fail",
"bwapi-status-reason": "Gerät nicht gefunden",
"userid": "email_id"
}

Benutzerdefinierte Daten

Diese API zeigt die vollständigen Details über alle aktiven Geräte.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domain name/bwiot/api/v1/devices_custom_data/

Parameter :

PARAMETER	VALUE DETAIL
Seite_no	-1

Beispiel Antwort:

{\cHFFFF}
"next_page": falsch,
"userid": " [email protected]",
"bwapi-status": "Erfolg",
"error": "noerror",
"Daten": [
{\cHFFFF}
"last_received_message": "-",
"last_received_message_time": "-",
"last_active": "Inaktiv",
"active_topics": [
(
"soc1/onoff"
!
,
"device_name": "Socket1",
"device_connected_time": "03-08-2018 11:00:54",
"device_id": "demo1/s1",
},
{\cHFFFF}
"last_received_message_time": "04-08-2018 16:57:47",
"last_active": "Aktiv",
"active_topics": [
(
"mytopisch"
!
,
"device_name": 'test_device',
"device_connected_time": "04-08-2018 16:57:46",
"device_id": "publisherclient1",
"last_received_message": "Hallo ich bin Verlag1"
},
,
"page_no": -1
}

Gerätegruppe erstellen

Diese API hilft Ihnen, Ihre Geräte oder Maschinen basierend auf Abteilungen.

Anfrage:

Anfrage::

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/admin/createDeviceGroup

Parameter :

PARAMETER	VALUE DETAIL
Gruppe_Name	Name der Gruppe
Beschreibung	Beschreibung

Gerätegruppe herunterladen

Diese API hilft Ihnen, Details über die jeweilige Gerätegruppe zu erhalten

Anfrage:

Anfrage::

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/admin/getDeviceGroup

Gerätegruppe entfernen

Diese API hilft Ihnen, die erstellte oder bestehende Gerätegruppe zu entfernen.

Anfrage:

Anfrage::

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/admin/removeDeviceGroup

Parameter :

PARAMETER	VALUE DETAIL
Gruppe_Name	Name der Gruppe

Geräte zur Gerätegruppe hinzufügen

Diese API hilft Ihnen, neue Geräte dem jeweiligen Gerät hinzuzufügen Gruppe.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/admin/addDeviceToDeviceGroup

Parameter :

PARAMETER	VALUE DETAIL
Gruppe_Name	Name der Gruppe
Vorrichtung Liste	[„device1“, „device2“, ...“

Details zur Gerätegruppe

Diese API hilft Ihnen, Details über die Geräte der insbesondere Gerätegruppe.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/admin/getGroupDevices

Parameter :

PARAMETER	VALUE DETAIL
Gruppe_Name	Name der Gruppe

Gerät aus Gerätegruppen entfernen

Diese API kann verwendet werden, um bestimmte Geräte aus dem Gerät zu entfernen Gruppe.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/admin/removeGroupDevice

Parameter :

PARAMETER	VALUE DETAIL
Gruppe_Name	Name der Gruppe
Gerät_id	Gerätid

Benutzer erstellen

Diese API hilft Ihnen, einen neuen Benutzer basierend auf ihrer E-Mail-ID erstellen entlang mit Berechtigungen als Standard / Verwaltung zuweisen.

Anfrage:

Autorisierung Header hinzufügen:

POST https://server IP oder Domainname/bwiot/api/v1/admin/createUser

Parameter :

PARAMETER	VALUE DETAIL
user_permission	Standard/Administrativ
Anzeige_Name	Name
mobile_no	mobile nicht
Benutzername	Postleitzahl

Antwort:

Auf Erfolg

{\cHFFFF}
'bwapi-Status': 'Erfolg'
'bwapi-status-reason': 'Benutzer erstellt erfolgreich',
'userid': 'email_id '
}

Auf der Flucht

{\cHFFFF}
'bwapi-Status': 'verfehlt',
'bwapi-status-reason': 'Unable to handle your request at this time, Bitte versuchen Sie es nach einige Zeiten '
}

Bei Verwendung bereits registrierter E-Mail-ID

{\cHFFFF}
'bwapi-Status': 'verfehlt',
'bwapi-status-reason': 'Die E-Mail bereits registriert '
}

User Status Changer (aktiv/inaktiv)

Diese API hilft Ihnen, den Status des Benutzers zu ändern, entweder als Active oder Inaktiv.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/admin/userStatusChanger

Parameter :

PARAMETER	VALUE DETAIL
Benutzername	Postleitzahl
Status	aktiv/inaktiv

Antwort:

{\cHFFFF}
'bwapi-Status': 'Erfolg'
'bwapi-status-reason': 'Benutzerstatus geändert erfolgreich',
'current-status': 'Active'
}

Auf der Flucht

{\cHFFFF}
'bwapi-Status': 'verfehlt',
'bwapi-status-reason': 'Nicht gefunden'
}

Alle Benutzer

Diese API hilft Ihnen, Details über alle hinzugefügten Mieter zu erhalten.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/admin/get Benutzer

Antwort:

{\cHFFFF}
'bwapi-Status': 'Erfolg'
'Daten':
(
{'id': id des Benutzers,
E-Mail: 'email_id',
'login': 'date & time of login',
'join': 'date & time of join',
'Status': 'aktiv/inaktiv',
'Name': 'Benutzername',
'Kontakt': 'Zahl',
'role': 'role '
}

Auf der Flucht

{\cHFFFF}
'bwapi-Status': 'fail',
'bwapi-status-reason': 'reason',

'userid': 'email_id '
}

Entfernen Sie den Benutzer

Diese API hilft Ihnen, den jeweiligen Benutzer aus dem Admin zu entfernen Konsole.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/admin/removeUser

Parameter :

PARAMETER	VALUE DETAIL
Benutzername	Postleitzahl

Antwort:

{\cHFFFF}
'bwapi-Status': 'Erfolg'
'bwapi-status-reason': 'Removed User '
}

Auf der Flucht

{\cHFFFF}
'bwapi-Status': 'verfehlt',
'bwapi-status-reason': 'Nicht gefunden'
}

Benutzeroberfläche ändern

Sie können die Rolle eines Benutzers jederzeit ändern. Diese API hilft Ihnen Änderung die Rolle des Benutzers als administrativer / Standard.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/admin/userRoleChange

Parameter :

PARAMETER	VALUE DETAIL
Benutzername	Postleitzahl
Rolle	Verwaltung / Standard

Antwort:

Auf Erfolg, wenn Grenze ist 5:

{\cHFFFF}
'bwapi-Status': 'Erfolg'
'Permission': 'Rolle '
}

Auf der Flucht

{\cHFFFF}
'bwapi-Status': 'verfehlt',
'bwapi-status-reason': 'Invalid data'
}

Die Gerätegruppe des Benutzers erhalten

Diese API hilft Ihnen, die Details über die Gerätegruppen zu erhalten die einen bestimmten Benutzer.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/admin/getUserDeviceGroups

Parameter :

PARAMETER	VALUE DETAIL
Benutzername	Postleitzahl

Gerätegruppe zum Benutzer hinzufügen

Diese API hilft Ihnen, dem Benutzer eine Gerätegruppe hinzuzufügen und zu helfen Zuweisung Erlaubnis zur Ansicht oder Verwaltung der neu hinzugefügten Gerätegruppe.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/admin/addDeviceGroupToUser

Parameter :

PARAMETER	VALUE DETAIL
Benutzername	Postleitzahl
Gruppe_Name	Name der Gruppe
Berechtigung	Ansicht / Verwaltung

Gerätegruppe von Benutzer entfernen

Diese API hilft Ihnen, eine bestimmte Gerätegruppe aus der Benutzer.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/admin/removeDeviceGroup

Parameter :

PARAMETER	VALUE DETAIL
Benutzername	Postleitzahl
Gruppe_Name	Name der Gruppe

Benutzergruppe Berechtigungsänderung

Diese API hilft Ihnen, die Erlaubnis des Benutzers zu ändern, entweder Blick oder eine bestimmte Gerätegruppe verwalten.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/admin/groupPermissionChanger

Parameter :

PARAMETER	VALUE DETAIL
Benutzername	Postleitzahl
Gruppe_Name	Name der Gruppe
Berechtigung	Ansicht / Verwaltung

Eventregel für Geräte erstellen

Diese API hilft Ihnen, die bedingten Regeln zu erstellen Alarmstufe Ereignisse basierend auf dem empfangenen Thema oder Nachrichten.

Anfrage:

Anfrage::

Authorization Header hinzufügen

POST https://server IP oder Domain Name/Bwiot/api/v1/rule_engine/create_event_rule/device_alert

Anfrage

{\cHFFFF}
'mq_client': 'device_id',
'mq_topic': 'event_topic',
'msg_chk_type': 'with_out_key'
'whole_set_condition': 'match_any',
'check_set':[
{\cHFFFF}
'compare_with': Nachricht,
"Bedingung":
"Wert": 20,
}
{\cHFFFF}
'compare_with': Zeit,
„Bedingung":
'Stunde': 15,
'Minute': 7,
}
!
'response_message_type': "send_definiert",
'forward_mq_message': "message",
'forward_mq_client': "device_id",
'forward_mq_topic': "topic",
}

Antwort

{\cHFFFF}
"userid": "userId",
"bwapi-status-reason": "rule_plus",
"bwapi-status": "Erfolg",
}

Mail-Event-Regel erstellen

Diese API hilft Ihnen, die Regeln oder Alarmnachrichten als Post zu senden. in der angegebene E-Mail-ID.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domain Name/Bwiot/api/v1/rule_engine/create_event_rule/mail_alert

Anfrage

{\cHFFFF}
'mq_client': 'device_id',
'mq_topic': 'event_topic',
'msg_chk_type': 'with_out_key'
'whole_set_condition': 'match_any',
'check_set':[
{\cHFFFF}
'compare_with': Nachricht,
"Bedingung":
"Wert": 20,
}
{\cHFFFF}
'compare_with': Zeit,
„Bedingung":
'Stunde': 15,
'Minute': 7,
}
!
'response_message_type': "attach_meta",
'forwarding_mail': "mail_id",
'forwarding_subject': "subject"
, 'forwarding_body': "message",
}

Antwort

{\cHFFFF}
"userid": "userId",
"bwapi-status-reason": "rule_plus",
"bwapi-status": "Erfolg",
}

Websocket Eventregel für Gerät erstellen

Diese API hilft Ihnen, eine Eventregel für das Gerät zu erstellen, um die Alarmstufe Meldung als Benachrichtigung.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domain Name/Bwiot/api/v1/rule_engine/create_event_rule/ws_alert

Anfrage

{\cHFFFF}
'mq_client': 'device_id',
'mq_topic': 'event_topic',
'msg_chk_type': 'with_out_key '
, 'whole_set_condition': 'match_any '
, 'check_set':[
{\cHFFFF}
'compare_with': Nachricht,
"Bedingung":
"Wert": 20,
}
{\cHFFFF}
'compare_with': Zeit,
„Bedingung":
'Stunde': 15,
'Minute': 7,
}
!
'notification_title': "title",
'notification_body': "message",
}

Antwort

{\cHFFFF}
"userid": "userId",
"bwapi-status-reason": "rule_plus",
"bwapi-status": "Erfolg",
}

FCM-Eventregel für Gerät erstellen

Diese API hilft Ihnen, eine Eventregel für das Gerät zu erstellen, um die Daten als Benachrichtigung an Ihre Android oder ios App basierend auf FCM-Token.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domain Name/Bwiot/api/v1/rule_engine/create_event_rule/fcm_alert

Anfrage:

{\cHFFFF}
'mq_client': 'device_id',
'mq_topic': 'event_topic',
'msg_chk_type': 'with_out_key'
'whole_set_condition': 'match_any',
'check_set':[
{\cHFFFF}
'compare_with': Nachricht,
"Bedingung":

"Wert": 20,
}

{\cHFFFF}
'compare_with': Zeit,
„Bedingung":
'Stunde': 15,
'Minute': 7,
}
!
'notification_title': "title",
'notification_body': "message",
}

Antwort:

{\cHFFFF} "userid": "userId",
"bwapi-status-reason": "rule_plus",
"bwapi-status": "Erfolg",
}

Zeitregel erstellen

Diese API hilft Ihnen, eine Timerregel zu erstellen, um Daten an ein Gerät zu senden für eine eine bestimmte Zeit oder in einem bestimmten Zeitintervall.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domain Name/Bwiot/api/v1/rule_engine/create_timer_rule/device_alert

Anfrage

{\cHFFFF}
'device_id': 'device_id',
'topic': 'topic',
'Nachricht': 'Nachricht',
'Stunde': '0-24',
'Minute': '0-59',
'startdaterange': mm/dd/yyy,
'enddaterange': mm/dd/yyyy
}

Antwort

{\cHFFFF}
"userid": "userId",
"bwapi-status-reason": "rule_plus",
"bwapi-status": "Erfolg",
}

Regeln für die Zukunft

Diese API hilft Ihnen, die Liste aller erstellten Regeln zu erhalten.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domain name/bwiot/api/v1/rule_engine/get_rule_list

Anfrage

{\cHFFFF} 'page_no': 'number', }

Antwort

{\cHFFFF}
"Rules":
{\cHFFFF}
"Vorwärts": {\cHFFFF}
"reaction_method": "send_via_mqtt",
"mq_client": "device_id",
"response_message_type": "send_definiert",
"mq_topic": "topisch",
"mq_message": "message",
}
"Zeit": "1558690606980",
"id": "105",
"event": {\cHFFFF}
"time_check_set":[
(
"
„<“,
ANHANG
7,
!
!
"whole_set_condition": "match_any",
"mq_topic": "event_topic",
"check_set": [],
"msg_chk_type": "with_out_key",
"mq_client": "device_id",
}
}
{\cHFFFF}
"Vorwärts":
"reaction_method": "send_via_ws",

"notification_title": "title",
"notification_body": "message",
}
"Zeit": "1558693863847",
"id": "108",
"event": {\cHFFFF}
"time_check_set":[
(
"
„<“,
ANHANG
7,
!
!
"whole_set_condition": "match_any",

"mq_topic": "event_topic",
"check_set": [
(
"INCOMING_MSG",
"
20
!
(
"INCOMING_MSG",
"="
15
!
,
"msg_chk_type": "with_out_key",
"mq_client": "device_id",
}
},
{\cHFFFF}
"msg_chk_type": {\cHFFFF}
"reaction_method": "send_via_fcm",
"notification_title": "title",
"notification_body": "message",
}
"Zeit": "1558694345964",
"id": "109",
"event": {\cHFFFF}
"time_check_set":[
(
"
„<“,
ANHANG

7,
!
!
"whole_set_condition": "match_any",
"mq_topic": "event_topic",
"check_set": [
(
"INCOMING_MSG",
"
20
!
(
"INCOMING_MSG",
"="
15
!
,
"msg_chk_type": "with_out_key",
"mq_client": "device_id",
}

},
!
"page_nav_data": {\cHFFFF}
"next_page": falsch
"total_pages": 1,

"page_no": 0
}
"user_id": "user_id",
"bwapi-status": "Erfolg"
,

Löschen der Regel

Diese API hilft Ihnen, die erstellte Regel zu löschen.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domain name/bwiot/api/v1/rule_engine/delete_rule

Anfrage

{\cHFFFF} 'rule_id': 'numerisch', }

Antwort

{\cHFFFF}
"bwapi-status": "Erfolg",
"bwapi-status-reason": "Regel gelöscht",
"userid": "userid"
}

Geräteverwaltung

Sub-Devices anzeigen

Diese API hilft Ihnen, die Liste der Unter-Geräte zu erhalten

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/devicesecurity/show_subdevices

Parameter :

PARAMETER	WERTE
Das ist ein gutes Beispiel.	id

Auf Erfolg

{\cHFFFF}
„Bwapi-Status“: „Erfolg“
„userid“: „email_id“;
„Daten“
(
‚subdevice_id‘: ‚id of the subdevice‘,
„connect_status“: 0
!
}

Antwort

{\cHFFFF}
„bwapi-status“: „fail“;
„bwapi-status-reason“: „no_data_found“;
„userid“: ’email_id „
}

Details zu Sub-Device anzeigen

Diese API hilft Ihnen, die Details von Unter-Geräten zu erhalten

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domain Name/bwiot/api/v1/devicesecurity/show_subdevice_details

Parameter :

PARAMETER	WERTE
Unterabteilung	Unterabteilung

Erfolg

{\cHFFFF}
„Bwapi-Status“: „Erfolg“
„userid“: „email_id“;
„Daten“
(
‚sub_device_id‘: ‚id of the subdevice‘,
„client_name“: „Name des Clients“,
„command_topics“: [„topic1“, „topic2“, „topic3“],
„event_topics“: „eventtopic1“, „eventtopic2“, „eventtopic3“}
!
} }

Antwort

{\cHFFFF}
„bwapi-status“: „fail“;
„bwapi-status-reason“: „no_data_found“;
„userid“: ’email_id „
}

Sub-Device aktualisieren

Diese API hilft Ihnen, die Sub-Devices zu aktualisieren.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/devicesecurity/update_subdevice

Parameter :

PARAMETER	WERTE
Unterabteilung	Unterabteilung
Subdevice_name	Subdevice Name
Befehl_topic	Thema des Abonnements
Veranstaltungen_topic	zum Thema

Auf Erfolg

{\cHFFFF}
„Bwapi-Status“: „Erfolg“
„userid“: ’email_id „
}

Antwort

{\cHFFFF}
„bwapi-status“: „fail“;
„bwapi-status-reason“ „Gegenstand“
„userid“: ’email_id „
}

Sub-Devices hinzufügen

Diese API hilft Ihnen, Unter-Geräte hinzuzufügen

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/devicesecurity/add_subdevices

Parameter :

PARAMETER	WERTE
Unterabteilung	Unterabteilung
Subdevice_name	Subdevice Name
Befehl_topic	Thema des Abonnements
Veranstaltungen_topic	zum Thema

Erfolgreich

{\cHFFFF}
„Bwapi-Status“: „Erfolg“
„userid“: ’email_id „
}

Antwort

{\cHFFFF}
„bwapi-status“: „fail“;
„bwapi-status-reason“: „interner Fehler“
„userid“: ’email_id „
}

Sub-Device löschen

Diese API hilft Ihnen, Unter-Geräte zu löschen

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domainname/bwiot/api/v1/devicesecurity/delete_subdevices

Parameter :

PARAMETER	WERTE
Unterabteilung	Unterabteilung

Auf Erfolg

{\cHFFFF}
„Bwapi-Status“: „Erfolg“
„userid“: ’email_id „
}

Antwort

{\cHFFFF}
„bwapi-status“: „fail“;
„bwapi-status-reason“: „interner Fehler“
„userid“: ’email_id „
}

Überprüfen Sie die Einzigartigkeit der Client-ID

Diese API hilft Ihnen, die Einzigartigkeit der Client-ID zu überprüfen.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domain Name/Bwiot/api/v1/devicesecurity/check_uniqueness_of_clientid

Parameter :

PARAMETER	WERTE
Gerät_id_chk	Client-ID

Auf Erfolg

{\cHFFFF}
„Bwapi-Status“: „Erfolg“
„bwapi-status-reason“: „Client Id ist verfügbar“
„userid“: ’email_id „
}

Antwort

{\cHFFFF}
„bwapi-status“: „fail“;
„bwapi-status-reason“: „Client id ist bereits vorhanden“
„userid“: „email_id“;
}

Änderung des Zugangs Schlüsselstatus

Diese API hilft Ihnen, den Status des Zugangsschlüssels zu ändern.

Anfrage:

Authorization Header hinzufügen

POST https://server IP oder Domain Name/Bwiot/api/v1/devicesecurity/change_access_key_status

Parameter :

PARAMETER	WERTE
Zugriffsschlüssel	Auth Schlüssel
Gerät_id	Gerätid
Dateiname:	aktiv/inaktiv

Auf Erfolg

{\cHFFFF}
„Bwapi-Status“: „Erfolg“
„userid“: „email_id“;
„new_status“: „aktiv“
}

Auf der Flucht

{\cHFFFF}
„bwapi-status“: „fail“;
„bwapi-status-reason“: „Internal Error“,
„userid“: ’email_id „
}

Bevywise IoT Platform API Dokumentation

Einleitung

Voraussetzung für Bevywise IoT Platform

Typ 1: Authentication für direkte Anmeldung

Typ 2: Authentication für Amazon Alexa Skillset oder andere Anwendungsbereich

Anmelden API

Anfrage:

Antwort:

Auf der Flucht:

Login API

Anfrage:

Antwort:

Typ 2

Refresh Token API

Anfrage:

Antwort:

Autorisierung Header

Logout API

Methode:

Auth Key & Auth Token Generation

Anfrage:

Auth Keys bekommen

Anfrage:

Anfrage:

Authorization Header hinzufügen

Push FCM Token API

Anfrage:

HTTP Anfrage:

Authorization Header hinzufügen

Geräteliste hinzufügen

Anfrage:

HTTP Anfrage:

Authorization Header hinzufügen

Informationen zum Gerät

Anfrage:

Events von Device erhalten

Anfrage:

Befehle in Gerät empfangen

Anfrage:

Dashboard Details

Anfrage:

Aktives Abonnement erhalten

Anfrage

Liste der Clients mit einem Thema erhalten

Anfrage:

Befehl an ein Thema senden

Anfrage

Antwort

Aktive Abonnements für ein Gerät erhalten

Anfrage

Anfrage:

Authorization Header hinzufügen

Parameter

Antwort

Auf Erfolg

Auf der Flucht (STÖHNT)'bwapi-Status': 'fail','bwapi-status-reason': 'No Topic Found','userid': 'email_id'}

Befehl an ein Gerät senden

Anfrage:

Gerätename bearbeiten

Anfrage:

Erhalten Sie den letzten Status eines Geräts

Anfrage:

Löschen Gerät

Anfrage:

Anfrage:

Authorization Header hinzufügen

Benutzerdefinierte Daten

Anfrage:

Gerätegruppe erstellen

Anfrage:

Gerätegruppe herunterladen

Anfrage:

Gerätegruppe entfernen

Anfrage:

Geräte zur Gerätegruppe hinzufügen

Anfrage:

Details zur Gerätegruppe

Anfrage:

Gerät aus Gerätegruppen entfernen

Anfrage:

Auf der Flucht

(STÖHNT)
'bwapi-Status': 'fail',
'bwapi-status-reason': 'No Topic Found',
'userid': 'email_id'
}