La API REST presentada en este documento se puede utilizar para comunicarse con Bevywise IoT Platform for creating a mobile application for your IoT Solution or for integración Bevywise IoT Platfom con Amazon Alexa u otras aplicaciones avanzadas.
Bevywise IoT Platform soporta dos tipos de autenticación mecanismo usuarios pueden utilizar nuestro IoT Plataforma para integrarse con la aplicación móvil y con AlexaAmazon o otras aplicaciones avanzadas.
Una vez que configuras nuestro IoT Plataforma en tu entorno de nube, accede a el Consola de administrador e ir a la URL inferior para configurar la autenticación basada en su aplicación.
https://server IP o nombre de dominio/o/aplicaciones/
Si desea que su aplicación móvil se inicie con el nombre de usuario y contraseña directamente a través de nuestra API, llenar los detalles de la siguiente manera y guardarlo.
Nombre: 0 Nombre de la aplicación
Cliente id: Identificado se creará automáticamente no lo cambie
Secreto del cliente: < se creará automáticamente no lo cambie
Tipo de cliente: Confidencial
Tipo de subsidio de autorización: Propietario de recursos contraseña
Urls redireccionados:
Una vez que haya hecho la configuración, obtendrá el ID de cliente, cliente secreto, Tipo de cliente y tipo de subvención de autorización. Hacer una copia de seguridad de los detalles para más uso.
Esta autenticación se basa en la autenticación OAUTH2 que es utilizado para a aplicación con “OAUTH2 Authentication code grant flow”[ utilizado en Amazon Alexa habilidad establecido o Google assistance]. Llene los detalles como sigue y ahorre.
Nombre: 0 Nombre de la aplicación
Cliente id: Identificado se creará automáticamente no lo cambie
Secreto del cliente: < se creará automáticamente no lo cambie
Tipo de cliente: Confidencial
Tipo de subsidio de autorización: Código de autorización
Redirect urls: < redireccionar urls the alexa want consist
Una vez que haya hecho la configuración, obtendrá el ID de cliente, cliente secreto, Tipo de cliente y tipo de subvención de autorización. Hacer una copia de seguridad de los detalles para más uso.
Esta API le ayudará a crear una nueva cuenta en Bevywise IoT Plataforma.
Htp Solicitud:
POST https://server IP o dominio nombre/bwiot/api/v1/auth/signup/
Parámetros:
| PARAMETER | VALUE DETAIL |
|---|---|
| nombre de usuario | email id del usuario |
| contraseña | cualquier clave |
| cliente_id | pegar el id cliente que se genera al crear autenticación |
| cliente_secret | pega el secreto del cliente que se genera al crear autenticación |
| Grant_type | contraseña [utiliza la palabra exacta "password" y no da al usuario contraseña] |
Sobre el éxito:
{}
"bwapi-status": "success",
"userid": "email_id",
"token": "el token",
"expires_in": "36000",
"refresh_token": "el token refrescante",
"Bwapi-status-reason": "successfullsignup"
}
{}
"bwapi-status": "fail"
mensaje: 'La cuenta no se puede crear con datos recibidos
{"nombre de usuario": ["Un usuario con ese nombre de usuario ya existe."]} '
}
Esta API le ayuda a iniciar sesión en Bevywise IoT Platform.
Tipo 1:
Para obtener ficha para la entrada normal o directa a la aplicación nombre de usuario y contraseña
Htp Solicitud:
POST https://server IP o nombre de dominio/bwiot/api/v1/auth/login/
Parámetros:
| PARAMETER | VALUE DETAIL |
|---|---|
| nombre de usuario | email id del usuario |
| contraseña | cualquier clave |
| cliente_id | pegar el id cliente que se genera al crear autenticación |
| cliente_secret | pega el secreto del cliente que se genera al crear autenticación |
| Grant_type | contraseña [utiliza la palabra exacta "password" y no da al usuario contraseña] |
Sobre el éxito:
{}
"bwapi-status": "success",
"token": "el token",
"refresh_token": "refresh token value",
"expires_in": "36000",
"Bwapi-status-reason": "successfulllogin"
"userid": "email_id",
}
En el fracaso:
{}
"Bwapi-status-reason": "Crédulas Inválidas",
"bwapi-status": "fail"
}
Utilice los detalles generados después de configurar Authentication en
Bevywise IoT
plataforma para integrar Plataforma Bevywise IoT a su servidor de conjunto de habilidades alexa u otro
servidor que
tiene flujo de código de autorización oauth2.
Proporcionar los detalles basados en los detalles siguientes para otros url necesarios y ejemplo en
oauth2
flujo de código de autorización
Tipo de concesión de autorización: Auth Code Grant
Authorization URL: https://devicemanager.bevywise.com/o/authorize/
Access Token URL: https://devicemanager.bevywise.com/o/token/
ID del cliente: copiar y pegar el id del cliente creado de Authentication
Secreto del Cliente: copiar y pegar el Secreto del Cliente creado de Authentication
Tipo 2
Autenticación del cliente Plan: Htp Basic
Ámbito: Read Write
Nota: Sólo la API de inicio de sesión debe variar para la aplicación normal y la aplicación con Amazon Alexa. Aparte de esto, todos los siguientes API son iguales para ambos aplicaciones.
El Token recogido de inicio de sesión o registro expirará después de algunos tiempo. A refrescar el token utilizar la API inferior en lugar de reiniciar.
Htp Solicitud:
POST https://server IP o nombre de dominio/bwiot/api/v1/auth/refresh/
Parámetros:
| PARAMETER | VALUE DETAIL |
|---|---|
| cliente_id | pegar el id cliente que se genera al crear autenticación |
| cliente_secret | pega el secreto del cliente que se genera al crear autenticación |
| Grant_type | refres_token [utiliza la palabra exacta "refresh_token" y no da la contraseña de usuario] |
| refresco_token | refrescar token de inicio de sesión o registrarse o refresco previo |
Sobre el éxito:
{}
"bwapi-status": "success",
"token": "el token",
"refresh_token": "refresh token value",
"expires_in": "36000",
"Bwapi-status-reason": "successfulllogin"
"userid": "email_id",
}
En el fracaso:
{}
"Bwapi-status-reason": "Crédulas Inválidas",
"bwapi-status": "fail"
}
El encabezado de autorización es el método de proporcionar autenticación información. Todas las API de abajo están accediendo a datos específicos para un usuario. Necesitamos añadir el período de sesiones token to todos ellos. The Session token should be set as part of the Request Header to provide información de autenticación. El formato del encabezado de Autorización es:
Autorización: Bearer
Respuestas de error Al utilizar el encabezado de autorización:
Si el encabezado de autorización no está definido
{}
“Detalle”: “No se proporcionaron credenciales de captura. ”
}
Si Token es inválido
{}
“detalle”: “Token inválida. ”
}
Esta API ayuda a su aplicación a logout desde el Bevywise IoT plataforma
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/auth/logout/
Parámetro :
| PARAMETER | VALOR DETALLES |
|---|---|
| nombre de usuario | pegar el id cliente que se genera al crear autenticación |
| cliente_secret | pega el secreto del cliente que se genera al crear autenticación |
| token | usuario token |
Respuesta:
Sobre el éxito:
{}
"bwapi-status": "success",
"Bwapi-status-reason": "user logged out"
}
En el fracaso:
{}
"Detalles": "Las credenciales de la autenticación no se proporcionaron"
}
Esta API proporcionará Auth key[mqtt username] y Auth token[mqtt contraseña] Conecta tu sensor o dispositivo con autenticación.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/devicesecurity/generatekey/
Parámetro :
| PARAMETER | VALOR DETALLES |
|---|---|
| device_type | borde/puerta |
| protocolo | MQTT/HTTP |
| permisos | Leer / Leer / Escribir |
| key_desc | descripción |
| device_id | dispositivo id |
| device_name | Nombre del dispositivo |
| keep_alive | mantener vivo (en segundos) |
Respuesta:
Sobre el éxito:
{}
"bwapi-status": "success",
"data":
{"device_id": "id of the device",
"auth_key": "mqusername",
"auth_token": "mqpassword",
"descripción": "desc",
"permissions": "permission"}
"userid": "email_id",
}
En el fracaso:
{}
"Bwapi-status-reason": "Reason",
"userid": "email_id",
"bwapi-status": "fail"
}
Esta API ayudará a obtener las teclas Auth generadas.
POST https://server IP o nombre de dominio/bwiot/api/v1/devicesecurity/get_auth_keys
Respuesta:
Cuando el dispositivo se conecta:
{}
"bwapi-status": "success",
"userid": "email_id",
"data":
[
{"client_id": "id of the client",
"device_type": "Gateway",
"protocolo": "MQTT",
"auth_key": "mqusername",
"auth_token": "mqpassword",
"descripción": "desc",
"permissions": "permission"}
"created_at": "tiempo en el que se crea el dispositivo",
"descripción": "desc",
"connect_status": "activo/inactivo",
"device_img": "image",
"keep_alive": 60,
"status": 0
}
En Failed
{} "Bwapi-status-reason": "Reason", "userid": "email_id", "bwapi-status": "fail" }
Esta API le ayudará a presionar la notificación a su móvil aplicación usando la integración FCM.
POST https://server IP o nombre de dominio/bwiot/api/v1/auth/pushfcm/
Parámetro :
| PARAMETER | VALOR DETALLES |
|---|---|
| notificación_token | fcm token value |
| dispositivo | ios o androides o web |
Nota: Para el dispositivo utilice la palabra exacta para el tipo de dispositivo. Para ejemplo, si tu tipo de dispositivo es androide, luego usa “android” como dispositivo.
Esta API le ayuda a conseguir el dispositivo conectado activo e inactivo lista.
Nota : set page_no = -1 para conseguir todos los dispositivos
POST https://server IP o nombre de dominio/bwiot/api/v1/devices/
Parámetro :
| PARAMETER | VALUE DETAIL |
|---|---|
| page_no | no de la página |
Respuesta:
Cuando el dispositivo se conecta:
{}
"bwapi-status": "success",
"data":
[
{"device_id": "id of the device",
"device_name": "nombre del dispositivo",
"last_active": "inactive",
"device_connected_time": "time"},
{"device_id": "id of the device",
"device_name": "nombre del dispositivo",
"last_active": "inactive",
"device_connected_time": tiempo
}
En Failed
Si Auth_keys no se genera
{}
"Bwapi-status-reason": "Device Auth Keys Not Found",
"userid": "email_id",
"bwapi-status": "fail",
}
Si no hay dispositivo encontrado o no hay datos encontrados para la página solicitada no
{}
"bwapi-status": "fail",
"userid": "email_id",
"Bwapi-status-reason": "No hay dispositivo / página inválida",
}
Si un error de servidor
{}
"Bwapi-status-reason": "Internal Error",
"userid": "email_id",
"bwapi-status": "fail",
}
Esta API le ayuda a obtener el detalle del dispositivo.
Htp Solicitud:
Añadir Authorization Header:
POST https://server IP o nombre de dominio/bwiot/api/v1/devices/get_device_detail
Parámetro :
| PARAMETER | VALUE DETAIL |
|---|---|
| device_id | id_of_the_device para el cual quieres saber detalles |
Respuesta:
Cuando el dispositivo se conecta:
{}
'bwapi-status': 'success',
'device_id': 'id of the device',
'device_name':'nombre del dispositivo '
'will_topic': 'willtopic',
'will_message': 'willmessage',
'device_status': 'status',
'userid': 'email_id',
}
En el fracaso
{}
"bwapi-status": "fail",
"Bwapi-status-reason": "Device Not Found",
"userid": "email_id",
}
Esta API proporciona la lista de eventos como publicar tema, mensaje o carga útil recibido de un dispositivo en particular.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/devices/get_device_recv_detail
Parámetro:
| PARAMETER | VALUE DETAIL |
|---|---|
| page_no | página no |
| device_id | id del dispositivo |
Respuesta:
{}
'bwapi-status':'success',
'recv_data':
[
{'device_id':'id of the device'',
'device_name':'nombre del dispositivo',
'topic_name':'name of the topic the event occured',
'mensaje'' :'event',
'timestamp':'time the event occured ' '
}
'page_nav_data':
{ 'next_page':true/false',
'total_pages':'total pages',
'page_no':'current page'},
'userid':'email_id '
}
En Failed
{}
"bwapi-status": "fail",
"Bwapi-status-reason": "no_data_found",
"userid": "email_id",
}
Esta API proporciona la lista de temas suscritos y mensajes de un particular Dispositivo.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/devices/get_device_sent_detail
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| page_no | página noe |
| device_id | id del dispositivo |
Respuesta:
{}
'bwapi-status':'success',
'sent_data':
[
{'device_id':'id of the device',
'device_name':'nombre del dispositivo '
'topic_name':'name of the topic the event occurred',
'mensaje' :'event',
'timestamp':'time of the event occured'},
'page_nav_data':
{'next_page':True/False,
'total_pages':'total pages '
'page_no': 'current page',
'userid': 'email_id '
}
En Failed
{}
"bwapi-status": "fail",
"Bwapi-status-reason": "no_data_found",
"userid": "email_id"
}
Esta API le ayuda a obtener detalles del Dashboard de Bevywise IoT Plataforma.
Htp Solicitud:
Añadir Authorization Header:
# https://server IP o nombre de dominio/bwiot/api/v1/dashboard/
Respuesta:
{}
'bwapi-status': 'success',
'data':
{'active_client_count': no. de clientes activos,
'total_client_count': total no. de clientes,
'total_received_messages': total no. de mensajes recibidos,
'sec_message_count': recuento de mensajes,
'total_sent_message': total no.de mensajes enviados,
'recent_connections':
[
{'device_name': "nombre del dispositivo",
'device_id':'id del dispositivo',
'device_time': 'tiempo del dispositivo'},
'recent_disconnects':
'recent_messages':
[
{'device_id': 'id of the device',
'topic_name': "nombre del tema",
'message_name': 'event',
'recv_time': "time at which the message received"
}
'userid': 'email_id '
}
Si no hay datos encontrados
{}
"Bwapi-status-reason": "no_data_found",
"userid": "email_id",
"bwapi-status": "fail",
}
Si un error de servidor :
{}
"Bwapi-status-reason": "Internal Error",
"userid": "email_id",
"bwapi-status": "fail",
}
Proporcionar una lista de temas suscritos para un tema activo particular.
Htp Solicitud
Add Authorization Header
GEThttps://server IP o nombre de dominio/bwiot/api/v1/ic/get_active_topics
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| Tema | nombre del tema |
Respuesta:
Sobre el éxito
{}
'bwapi-status': 'success',
'active_topics': ['topic1, topic2'],
'userid': 'email_id '
}
ON Failure
{}
"bwapi-status": "fail",
"Bwapi-status-reason": "no_data_found",
"userid": "email_id",
}
Esta API le ayuda a enviar el comando a un tema.
Htp Solicitud:
Add Authorization Header
POST https://server IP o dominio nombre/bwiot/api/v1/ic/send_command_to_topic
Parámetros
| PARAMETER | VALUE DETAIL |
|---|---|
| Tema | nombre del tema para el que desea enviar el comando. |
| comando | comando o mensaje |
Sobre el éxito
{}
'bwapi-status': 'success',
'bwapi-status-reason': 'command send',
'userid': 'email_id '
}
En el fracaso
{}
'bwapi-status': 'fail',
'bwapi-status-reason': 'El dispositivo no está activo/no se encuentra',
'userid': 'email_id '
}
Esta API le ayuda a obtener las suscripciones activas de un dispositivo.
POST https://server IP o nombre de dominio/bwiot/api/v1/ic/get_active_topics_for_this_device
| PARAMETER | VALUE DETAIL |
|---|---|
| device_id | id del dispositivo |
{}
'bwapi-status': 'success',
'topics': ['topic1', 'topic2'],
'userid': 'email_id '
}
{}
'bwapi-status': 'fail',
"Bwapi-status-reason": No se ha encontrado ninguna foto,
'userid': 'email_id'
}
Utilizando esta API, puede enviar manualmente un comando o mensaje a la dispositivo basado en su tema suscrito.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/ic/send_command_to_device
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| Tema | nombre del dispositivo |
| comando | comando |
| device_id | id del dispositivo |
Respuesta:
Sobre el éxito
{}
'bwapi-status': 'success',
'bwapi-status-reason':'command send',
'userid': 'email_id '
}
Failed
{}
"bwapi-status": "fail",
"Bwapi-status-reason": "El dispositivo no está activo/no encontrado",
"userid": "email_id"
}
Esta API se utiliza para cambiar o modificar sólo el nombre del conectado Dispositivo.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/devices/edit_device_name
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| new_device_name | nombre del dispositivo para establecer |
| device_id | ID del dispositivo para el que desea cambiar el nombre |
Respuesta:
Sobre el éxito
{}
'bwapi-status': 'success',
'device_name': 'nombre del dispositivo',
'userid': 'email_id '
}
Fallo
{}
"bwapi-status": "fail",
"bwapi-status-reason": "no_matching_device_id_found",
"userid": "email_id"
}
Esta API solía obtener un estado como mensaje recibido sello de tiempo, dispositivo estado, último mensaje recibido etc para un dispositivo en particular.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/devices/get_last_status_of_device
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| device_id | id del dispositivo |
Respuesta:
Sobre el éxito
{}
'device_status': 'device status',
'device_id': 'id of the device',
'device_name': 'nombre del dispositivo',
"último mensaje recibido"
'recibido_at': 'tiempo en el que se recibe el último mensaje',
'device_status': 'activo/inactivo',
'useri': 'email_id '
}
Failed
{}
"bwapi-status": "fail",
"Bwapi-status-reason": "Device Not Found",
"userid": "email_id",
}
Esta API se utiliza para eliminar un dispositivo en particular de Bevywise IoT Plataforma permanentemente.
POST https://server IP o nombre de dominio/bwiot/api/v1/devices/delete_device/
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| device_id | id del dispositivo |
Respuesta:
Sobre el éxito
{}
'bwapi-status': 'success',
'bwapi-status-reason': 'device_deleted',
'userid': 'email_id '
}
Failed
{}
"bwapi-status": "fail",
"Bwapi-status-reason": "Device Not Found",
"userid": "email_id"
}
Esta API mostrará los detalles completos sobre todos los dispositivos activos.
Htp Solicitud:
Add Authorization Header
POST https://server IP or domain name/bwiot/api/v1/devices_custom_data/
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| page_no | -1 |
Respuesta de ejemplo:
{}
"next_page": falso,
"userid": " [email protected]",
"bwapi-status": "success",
"error"
"data":
{}
"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":
[
"mitópico"
]
]
"device_name": 'test_device',
"device_connected_time": "04-08-2018 16:57:46",
"device_id": "publisherclient1",
"last_received_message": "hola soy editor1"
}
]
"page_no":
}
Esta API le ayudará a agrupar sus dispositivos o máquinas basadas en Departamentos.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/admin/createDeviceGroup
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| group_name | nombre del grupo |
| descripción | descripción |
Esta API le ayudará a obtener detalles sobre el grupo de dispositivo en particular
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/admin/getDeviceGroup
Esta API le ayuda a eliminar el grupo creado o existente del dispositivo.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/admin/removeDeviceGroup
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| group_name | nombre del grupo |
Esta API le ayudará a agregar nuevos dispositivos al dispositivo en particular grupo.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/admin/addDeviceToDeviceGroup
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| group_name | nombre del grupo |
| dispositivo Lista | [“dispositivo1”, “dispositivo2”, ...] |
Esta API le ayudará a obtener detalles sobre los dispositivos de los particular grupo de dispositivos.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/admin/getGroupDispositivos
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| group_name | nombre del grupo |
Esta API se puede utilizar para eliminar ciertos dispositivos del dispositivo Grupo.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/admin/removeGroupDevice
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| group_name | nombre del grupo |
| device_id | dispositivo id |
Esta API le ayudará a crear un nuevo usuario basado en su id de correo y con asignar permisos como estándar / administrativo a ellos.
Htp Solicitud:
Añadir Authorization Header:
POST https://server IP o nombre de dominio/bwiot/api/v1/admin/createUser
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| user_permission | estándar/administrativo |
| display_name | Nombre |
| mobile_no | móvil no |
| nombre de usuario | mail id |
Respuesta:
Sobre el éxito
{}
'bwapi-status': 'success',
'bwapi-status-reason': 'User Created Successfully',
'userid': 'email_id '
}
En Failed
{}
'bwapi-status': 'failed',
'bwapi-status-reason': 'Unable to handle your request at this time, Please try after
algunos
veces '
}
Si se utiliza ya registrado correo id
{}
'bwapi-status': 'failed',
"Bwapi-status-reason": 'El email ya registrado '
}
Esta API le ayuda a cambiar el estado del usuario, ya sea como activo o Inactivo.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/admin/userStatusChanger
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| nombre de usuario | mail id |
| Situación | activo/inactivo |
Respuesta:
{}
'bwapi-status': 'success',
'bwapi-status-reason': 'User status changed successfully',
'current-status': 'Active'
}
En Failed
{}
'bwapi-status': 'failed',
'bwapi-status-reason': 'User not found'
}
Esta API le ayudará a obtener detalles sobre todos los inquilinos añadidos.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/admin/get Usuarios
Respuesta:
{}
'bwapi-status': 'success',
'data':
[
id del usuario,
'email': 'email_id',
'login': 'date & time of login',
'join': 'fecha' hora de unirse',
'status': 'activo/inactivo',
'nombre de usuario',
'contact': 'número',
'role': 'role' '
}
En Failed
{}
'bwapi-status': 'fail',
'bwapi-status-reason': 'reason',
'userid': 'email_id '
}
Esta API le ayuda a eliminar el usuario particular del administrador consola.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/admin/removeUser
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| nombre de usuario | mail id |
Respuesta:
{}
'bwapi-status': 'success',
'bwapi-status-reason': 'Removed User '
}
En Failed
{}
'bwapi-status': 'failed',
'bwapi-status-reason': 'User not found'
}
Puede cambiar el papel de un usuario en cualquier momento. Esta API te ayuda cambio el función del usuario como estándar administrativo.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/admin/userRoleChange
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| nombre de usuario | mail id | función | administrativo / estándar |
Respuesta:
Sobre el éxito cuando el límite es 5:
{}
'bwapi-status': 'success',
'permisión': 'role '
}
En Failed
{}
'bwapi-status': 'failed',
'bwapi-status-reason': 'Datos inválidos'
}
Esta API le ayudará a obtener los detalles sobre los grupos de dispositivos el usuario particular.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/admin/getUserDeviceGroups
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| nombre de usuario | mail id |
Esta API le ayudará a agregar un grupo de dispositivo al usuario y a ayudar en asignación permiso para ver o gestionar el nuevo grupo de dispositivos añadido.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/admin/addDeviceGroupToUser
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| nombre de usuario | mail id |
| group_name | nombre del grupo |
| permiso | vista / administración |
Esta API le ayudará a eliminar un grupo de dispositivo en particular del usuario.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/admin/removeDeviceGroup
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| nombre de usuario | mail id |
| group_name | nombre del grupo |
Esta API le ayudará a cambiar el permiso del usuario para vista o administrar un grupo de dispositivos en particular.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/admin/groupPermissionChanger
Parámetros :
| PARAMETER | VALUE DETAIL |
|---|---|
| nombre de usuario | mail id |
| group_name | nombre del grupo |
| permiso | vista / administración |
Esta API le ayudará a crear reglas basadas en condiciones para crear alerta eventos basados en el tema recibido o mensajes.
Htp Solicitud:
Add Authorization Header
POST https://server IP o dominio nombre/bwiot/api/v1/rule_engine/create_event_rule/device_alert
Solicitud
{}
'mq_client': 'device_id',
'mq_topic': 'event_topic',
'msg_chk_type': 'with_out_key',
'whole_set_condition': 'match_any',
'check_set':
{}
'compare_with': mensaje,
'condición': ,
"valor": 20,
}
{}
'compare_with': tiempo,
'condición':
15,
'Minute': 7,
}
]
'response_message_type': "send_definido",
'forward_mq_message': "message",
'forward_mq_client': "device_id",
'forward_mq_topic': "topic",
}
Respuesta
{}
"userid": "userId",
"Bwapi-status-reason": "rule_added",
"bwapi-status": "success",
}
Esta API le ayudará a enviar las reglas o mensajes de alerta como correo to the correo especificado id.
POST https://server IP o dominio nombre/bwiot/api/v1/rule_engine/create_event_rule/mail_alert
Solicitud
{}
'mq_client': 'device_id',
'mq_topic': 'event_topic',
'msg_chk_type': 'with_out_key',
'whole_set_condition': 'match_any',
'check_set':
{}
'compare_with': mensaje,
'condición': ,
"valor": 20,
}
{}
'compare_with': tiempo,
'condición':
15,
'Minute': 7,
}
]
'response_message_type': "attach_meta",
'forwarding_mail': "mail_id",
'forwarding_subject': "subject"
,
'forwarding_body': "message",
}
Respuesta
{}
"userid": "userId",
"Bwapi-status-reason": "rule_added",
"bwapi-status": "success",
}
Esta API le ayudará a crear una regla de evento para el dispositivo para empujar alerta mensaje como notificación.
Htp Solicitud:
Add Authorization Header
POST https://server IP o dominio nombre/bwiot/api/v1/rule_engine/create_event_rule/ws_alert
Solicitud
{}
'mq_client': 'device_id',
'mq_topic': 'event_topic',
'msg_chk_type': 'with_out_key '
,
'whole_set_condition': 'match_any '
,
'check_set':
{}
'compare_with': mensaje,
'condición': ,
"valor": 20,
}
{}
'compare_with': tiempo,
'condición':
15,
7.
}
]
'notification_title': "title",
'notification_body': "message",
}
Respuesta
{}
"userid": "userId",
"Bwapi-status-reason": "rule_added",
"bwapi-status": "success",
}
Esta API le ayudará a crear una regla de evento para el dispositivo para empujar datos como notificación a su aplicación android o ios basado en token FCM.
Htp Solicitud:
Add Authorization Header
POST https://server IP o dominio nombre/bwiot/api/v1/rule_engine/create_event_rule/fcm_alert
Solicitud:
{}
'mq_client': 'device_id',
'mq_topic': 'event_topic',
'msg_chk_type': 'with_out_key',
'whole_set_condition': 'match_any',
'check_set':
{}
'compare_with': mensaje,
'condición': ,
"valor": 20,
}
{}
'compare_with': tiempo,
'condición':
15,
7.
}
]
'notification_title': "title",
'notification_body': "message",
}
Respuesta:
{}
"userid": "userId",
"Bwapi-status-reason": "rule_added",
"bwapi-status": "success",
}
Esta API le ayudará a crear una regla timer para enviar datos a un dispositivo para a tiempo específico o en un intervalo de tiempo específico.
Htp Solicitud:
Add Authorization Header
POST https://server IP o dominio nombre/bwiot/api/v1/rule_engine/create_timer_rule/device_alert
Solicitud
{}
'device_id': 'device_id',
'topic': 'topic',
'mensaje': 'mensaje',
'hora': '0-24',
'minuto': '0-59',
'startdaterange': mm/dd/yyyy,
'enddaterange': mm/dd/yyyyy,
}
Respuesta
{}
"userid": "userId",
"Bwapi-status-reason": "rule_added",
"bwapi-status": "success",
}
Esta API le ayudará a obtener la lista de todas las reglas creadas.
Htp Solicitud:
Add Authorization Header
POST https://server IP or domain name/bwiot/api/v1/rule_engine/get_rule_list
Solicitud
{} 'page_no': 'number', }
Respuesta
{}
'rules':
{}
"para adelante": {}
"reaction_method": "send_via_mqtt",
"mq_client": "device_id",
"response_message_type": "send_definido",
"mq_topic": "topic",
"mq_message": "mensage",
}
"tiempo": "1558690606980",
"id": "105",
"event": {}
"time_check_set": [
[
"
"Seguido"
15,
7,
]
]
"whole_set_condition": "match_any",
"mq_topic": "event_topic",
"check_set":
"msg_chk_type": "with_out_key",
"mq_client": "device_id",
}
}
{}
"para adelante":
"reaction_method": "send_via_ws",
"notification_title": "title",
"notification_body": "message",
}
"tiempo": "1558693863847",
"id": "108",
"event": {}
"time_check_set": [
[
"
"Seguido"
15,
7,
]
]
"whole_set_condition": "match_any",
"mq_topic": "event_topic",
"check_set":
[
"INCOMING_MSG",
"Contra"
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": "message",
}
"tiempo": "1558694345964",
"id": "109",
"event": {}
"time_check_set": [
[
"
"Seguido"
15,
7,
]
]
"whole_set_condition": "match_any",
"mq_topic": "event_topic",
"check_set":
[
"INCOMING_MSG",
"Contra"
20
]
[
"INCOMING_MSG",
"="
15
]
]
"msg_chk_type": "with_out_key",
"mq_client": "device_id",
}
}
]
"page_nav_data": {}
"next_page": false
"total_pages": 1,
"page_no": 0
}
"user_id": "user_id",
"bwapi-status": "suceso"
,
Esta API le ayudará a eliminar la regla creada.
Htp Solicitud:
Add Authorization Header
POST https://server IP or domain name/bwiot/api/v1/rule_engine/delete_rule
Solicitud
{} 'rule_id': 'numeric', }
Respuesta
{}
"bwapi-status": "success",
"Bwapi-status-reason": "Rule Deleted",
"userid": "userid"
}
Mostrar sub-dispositivos
Esta API le ayudará a obtener la lista de sub-dispositivos
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/devicesecurity/show_subdevices
Parámetros :
| PARAMETER | VALUES |
|---|---|
| gateway_device_id | dispositivo de entrada id |
Sobre el éxito
{}
‘bwapi-status’: ‘success’,
‘userid’: ’email_id’,
‘data’:
[
{‘subdevice_id’: ‘id of the subdevice’,
‘connect_status’: 0
]
}
Respuesta
{}
‘bwapi-status’: ‘fail’,
‘bwapi-status-reason’: ‘no_data_found’,
‘userid’: ’email_id ’
}
Esta API le ayudará a obtener los detalles de sub-dispositivos
Htp Solicitud:
Add Authorization Header
POST https://server IP o dominio nombre/bwiot/api/v1/devicesecurity/show_subdevice_details
Parámetro :
| PARAMETER | VALUES |
|---|---|
| subdevice_id | subdispositivo id |
Éxito
{}
‘bwapi-status’: ‘success’,
‘userid’: ’email_id’,
‘data’:
[
{‘sub_device_id’: ‘id of the subdevice’,
‘client_name’: ‘nombre del cliente’,
‘command_topics’: [‘topic1’, ‘topic2’, ‘topic3’],
“event_topics”: [“eventopic1”, “eventopic2”, “eventopic3”]
]
}
}
Respuesta
{}
‘bwapi-status’: ‘fail’,
‘bwapi-status-reason’: ‘no_data_found’,
‘userid’: ’email_id ’
}
Esta API le ayudará a actualizar los subdispositivos.
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/devicesecurity/update_subdevice
Parámetro :
| PARAMETER | VALUES |
|---|---|
| subdevice_id | subdispositivo id |
| subdevice_name | subdevice name |
| comando_topic | tema de la suscripción |
| events_topic | publicar tema |
Sobre el éxito
{}
‘bwapi-status’: ‘success’,
‘userid’: ’email_id ’
}
Respuesta
{}
‘bwapi-status’: ‘fail’,
“bwapi-status-reason” : ‘razón’,
‘userid’: ’email_id ’
}
Esta API le ayudará a añadir sub-dispositivos
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/devicesecurity/add_subdevices
Parámetro :
| PARAMETER | VALUES |
|---|---|
| subdevice_id | subdispositivo id |
| subdevice_name | subdevice name |
| comando_topic | tema de la suscripción |
| events_topic | publicar tema |
éxito
{}
‘bwapi-status’: ‘success’,
‘userid’: ’email_id ’
}
Respuesta
{}
‘bwapi-status’: ‘fail’,
‘bwapi-status-reason’ : ‘error interno’,
‘userid’: ’email_id ’
}
Esta API le ayudará a eliminar sub-dispositivos
Htp Solicitud:
Add Authorization Header
POST https://server IP o nombre de dominio/bwiot/api/v1/devicesecurity/delete_subdevices
Parámetro :
| PARAMETER | VALUES |
|---|---|
| subdevice_id | subdispositivo id |
Sobre el éxito
{}
‘bwapi-status’: ‘success’,
‘userid’: ’email_id ’
}
Respuesta
{}
‘bwapi-status’: ‘fail’,
‘bwapi-status-reason’ : ‘error interno’,
‘userid’: ’email_id ’
}
Esta API le ayudará a comprobar la singularidad del ID del cliente.
Htp Solicitud:
Add Authorization Header
POST https://server IP o dominio nombre/bwiot/api/v1/devicesecurity/check_uniqueness_of_clientid
Parámetro :
| PARAMETER | VALUES |
|---|---|
| device_id_chk | cliente id |
Sobre el éxito
{}
‘bwapi-status’: ‘success’,
“bwapi-status-reason”: ‘Client Id está disponible’,
‘userid’: ’email_id ’
}
Respuesta
{}
‘bwapi-status’: ‘fail’,
“bwapi-status-reason”: ‘Client id ya existe’,
‘userid’: ’email_id’,
}
Esta API le ayudará a cambiar el estado de la clave de acceso.
Htp Solicitud:
Add Authorization Header
POST https://server IP o dominio nombre/bwiot/api/v1/devicesecurity/change_access_key_status
Parámetro :
| PARAMETER | VALUES |
|---|---|
| accesskey | Auth key |
| device_id | dispositivo id |
| string_status | activo/inactivo |
Sobre el éxito
{}
‘bwapi-status’: ‘success’,
‘userid’: ’email_id’,
‘new_status’: ‘active’
}
En Failed
{}
‘bwapi-status’: ‘fail’,
‘bwapi-status-reason’: ‘Internal Error’,
‘userid’: ’email_id ’
}
Utilizamos cookies para mejorar tu experiencia. Su aceptación implica nuestro acuerdo de política. Sus datos son manejado de forma segura, y usted puede aprender más acerca de nuestro compromiso con la seguridad de datos en nuestroPolítica de privacidad.