Saltar al contenido principal

Documentación de la API de Nescloud

  • Actualización
Integraciones y API
La API de datos de Nescloud permite obtener por programación la información de tus redes, dispositivos y sensores. Todas las llamadas necesitan una API Key en la cabecera x-api-key, que debes solicitar a Nespra.
Ten en cuenta
Base: https://data.nescloud.net. La mayoría de llamadas requieren, además de la API Key, un token de usuario que se obtiene con /auth/validate y se envía en la cabecera Authorization.
POST /auth/validate — obtener el token
Devuelve el token asociado a una cuenta de usuario. Cabecera requerida: x-api-key.
Cuerpo de la petición:
{ "username": "user@mail.com", "password": "foo" }
Si las credenciales son válidas (login_status: true), la respuesta incluye el user_id, nombre, las organizaciones a las que tiene acceso, el api_token y su expiration_time:
[{ "login_status": true, "user_id": 65, "first_name": "app", "last_name": "movil",
   "organizations": [{ "id": 2, "name": "Nespra Demo" }],
   "api_token": "L5S6FzpgslWuBhRsKQfRx4rTXKXwQst-XV6oOKvTVGs",
   "expiration_time": 1596105471 }]
GET /networks — redes de una organización
Devuelve Nesgates, Nesmotes, alertas y alarmas de una organización. Cabeceras: x-api-key y Authorization (el api_token).
Parámetro de query:
•organisation_id — el token debe pertenecer a un usuario de esa organización.
La respuesta lista cada red con sus nesgates y nesmotes (con deveui, name_model, GPS, sensor_labels, sensor_types, units…) y los contadores de alertas y alarmas.
GET /sensordata — datos de los sensores de un Nesmote
Cabeceras: x-api-key y Authorization. Parámetros de query:
•deveui — DevEUI del Nesmote (de la organización del usuario).
•t0 / t1 — instantes inicial y final (UNIX). El intervalo no puede superar 180 días.
•sensor_labels — sensores a consultar, separados por coma (p. ej. DO1,AI1).
•hourly (opcional) — true para la base de datos horaria.
•ig_module (IG) — mip, rtu, ai o di; con ip_host y port para datos de Modbus.
•accumulation_period (opcional) — daily u hourly.
•new_data_format — pon true para un formato de salida más simple.
Respuesta (con hourly=false, TimeStamp en UNIX):
[{ "TimeStamp": 1601480532, "AI2": 36.274, "AI1": 11.004 }]
Con hourly=true, cada punto usa yymmddhh (año, mes, día, hora) en lugar de TimeStamp.
POST /get-expert-knowledge — interpretación de valores
Cabeceras: x-api-key y Authorization. Recibe valores de sensores y devuelve, por cada uno, el color y el texto del conocimiento experto correspondiente.
Petición:
{ "dict_with_info": { "dev-eui-1": { "sensor_data": {
  "sensor-label-1": { "x_array": ["1682330002"], "y_array": ["448"] } } } } }
Respuesta:
{ "dev-eui-1_sensor-label-1": {
  "status_color_array": ["#008000"], "status_text_array": ["EXCELENTE"] } }
Atención
La API Key es privada y se solicita a Nespra. Antes de integrar, confirma con soporte que dispones de acceso vigente a la API de datos.
Manual de usuario de Nescloud · Integraciones y API. Si necesitas ayuda con un caso concreto, contacta con el soporte de tu organización.

Artículos relacionados

Tecnología de Zendesk