API – Librerías

Encuentra información detallada sobre las API de SDS, incluyendo la autenticación, los métodos, los parámetros, los formatos de respuesta y los errores. Las guías de usuario y los manuales completos están disponibles para los socios activos.
Las guías de usuario y los manuales completos están disponibles para los socios activos.

Dispositivos API

El API para dispositivos está basada Sentilo, una plataforma de sensores y actuadores de código abierto liderada por el Ayuntamiento de Barcelona y respaldada por una comunidad de empresas y personas que garantizan la innovación y el apoyo continuos. Puede encontrar una descripción completa de todos sus objetos y métodos aquí.

 

Recursos

Recursos existentes:

  • Sensor (dispositivo): entidad de hardware o software con la capacidad de generar una lectura.
  • Componente: elemento de hardware o software, con ubicación geoespacial (fija o móvil) que puede contener uno o más Sensores.
  • Proveedor: Entidad que representa un grupo de componentes y les proporciona conectividad con la plataforma. Se utiliza para enviar datos y recibir comandos.
  • Aplicación Cliente/Módulo: entidad que consume los datos procesados por la plataforma.

 

Acciones disponibles:

Aplicaciones/Módulos:

  • Enviar las órdenes a los proveedores/sensores (servicio de pedidos).
  • Recibir datos de los proveedores/sensores (servicio de datos).
  • Suscribirse a eventos del sistema (servicio de suscripción).

Proveedores/sensores:

  • Registrarse en la plataforma (servicio de catálogo).
  • Suscribirse a eventos del sistema (servicio de suscripción).
  • Publicar datos (servicio de datos).

 

Identificador:

Cada recurso tiene una URL que lo identifica de forma única dentro del sistema según el formato que se describe a continuación:

< View plain text >
php
  1. [API URL]/[service]

 

Formato de los datos

Actualmente, la API admite JSON como formato de datos predeterminado.

< View plain text >
php
  1. [API URL]/service/[id_provider] ?[PARAMETER]=[VALUE]

Ejemplo de datos en formato JSON:

< View plain text >
php
  1. {«observations»:[
  2. {«value»:«12.3»,«timestamp»:«17/09/2012T12:34:45»}
  3. ]}

Aplicaciones API

Encuentra una descripción general de los métodos y objetos relacionados con los sitios de implementación, los sensores y las mediciones disponibles para los desarrolladores que desean diseñar aplicaciones externas en la plataforma que elijan o integrar las existentes.

La referencia completa de la API está disponible en la interfaz web de la plataforma.

Seguridad

La plataforma validará cualquier solicitud recibida por el sistema en base a la arquitectura AAA (Autenticación, Autorización y Contabilidad).
Los tokens de autenticación se proporcionan cuando un socio se activa en la plataforma.

Servicios

Instalaciones

INSTALACIONES (Sitios de implementación)
A través de este servicio, puede recuperar la lista de instalaciones y los detalles relacionados asociados con tu usuario. Todas las solicitudes de este servicio deben tener el siguiente formato:

< View plain text >
php
  1. [API URL]/installations?[PARAMETER]=[VALUE]

 
Parámetros:

Key Description Mandatory
id Used to filter the list by the installation unique identifier No

 
Además del código de estado HTTP, esta acción devuelve la lista de instalaciones para las que tenemos permiso de lectura. Cada elemento de la lista tendrá la siguiente estructura:

Key Description
id Unique installation identifier
name Installation name
typology Installation typology
address Address of the installation
zip ZIP code of the installation
city City of the installation
State State of the installation
country Country of the installation
latitude GPS coordinates of the installation, latitude
longitude GPS coordinates of the installation, longitude

 
Ejemplo: Para recuperar detalles de la instalación con ID 142, tenemos que enviar la siguiente solicitud:

< View plain text >
php
  1. [API URL]/installations?id=142

 
En la respuesta recibiremos:

< View plain text >
php
  1. {«installations»:[
  2. {
  3. «id»:142,
  4. «name»:«Demo installation»,
  5. «typology»:«Datacenter»,
  6. «address»:«Passeig de Gràcia, 47»,
  7. «zip»:«08007»,
  8. «city»:«Barcelona»,
  9. «state»:«Barcelona»,
  10. «country»:«España»,
  11. «latitude»:41.392408931363,
  12. «longitude»:2.1645916698617
  13. }
  14. ]}

Sensores

A través de este servicio, puedes recuperar la lista de sensores y los detalles relacionados asociados con tu usuario. Todas las solicitudes de este servicio deben tener el siguiente formato:

< View plain text >
php
  1. [API URL]/sensors?[PARAMETER]=[VALUE]

 
Parámetros:

Key Description Mandatory
id Used to filter the list by the sensor unique identifier No
installationid Used to filter the list by the installation unique identifier No

 
Además del código de estado HTTP, esta acción devuelve la lista de instalaciones para las que tenemos permiso de lectura. Cada elemento de la lista tendrá la siguiente estructura:

Key Description
id Unique sensor identifier
installationId Unique installation identifier
name Name of the sensor
measurementUnit Measurement unit associated with the sensor
granularity Time interval (seconds) between two measurements
multiplier Value which any measurement will be multiplied by
offset Constant value added to any measurement after the operation above

 
Ejemplo: Para recuperar la lista de sensores asociados a la instalación con ID 142, tenemos que enviar la siguiente solicitud:

< View plain text >
php
  1. [API URL]/sensors?installationid=142

 
En la respuesta recibiremos:

< View plain text >
php
  1. {«sensors»:[
  2. {
  3. «id»:1517,
  4. «installationId»:142,
  5. «name»:«Datacenter temperature»,
  6. «measurementUnit»:«°C»,
  7. «granularity»:900,
  8. «multiplier»:1,
  9. «offset»:0
  10. },{
  11. «id»:1518,
  12. «installationId»:142,
  13. «name»:«Datacenter humidity»,
  14. «measurementUnit»:«%»,
  15. «granularity»:900,
  16. «multiplier»:1,
  17. «offset»:0
  18. }
  19. ]}

Mediciones

A través de este servicio, puedes recuperar la lista de mediciones recibidas a través de la plataforma. Todas las solicitudes de este servicio deben tener el siguiente formato:

 

< View plain text >
php
  1. [API URL]/measurements?[PARAMETER]=[VALUE]

 
Parámetros

Key Description Mandatory
sensorid Used to select the sensor Yes
begin Begin of the time interval, EPOCH format Yes
end End of the time interval, EPOCH format Yes
sampling Output data format (view table below) No
timeoffset Time offset (seconds) applied to any timestamp and sampling interval No

 
Formatos de datos de salida disponibles

Value Description
0 (Default) Individual measurements (raw values)
10 Hourly sampling, average value
11 Hourly sampling, minimum value
12 Hourly sampling, maximum value
13 Hourly sampling, minimum and maximum value
20 Daily sampling, average value
21 Daily sampling, minimum value
22 Daily sampling, maximum value
23 Daily sampling, minimum and maximum value
30 Monthly sampling, average value
31 Monthly sampling, minimum value
32 Monthly sampling, maximum value
33 Monthly sampling, minimum and maximum value
40 Yearly sampling, average value
41 Yearly sampling, minimum value
42 Yearly sampling, maximum value
43 Yearly sampling, minimum and maximum value

 
Además del código de estado HTTP, esta acción devuelve una lista de mediciones. Esta es la estructura de salida si el formato de datos de salida seleccionado es 0 (mediciones individuales):

Key Description
timestamp Timestamp of the measurement
value Value of the measurement

 
En el caso de que el formato de datos de salida especificado sea 10, 11, 12, 20, 21, 22, 30, 31 o 32, la estructura de salida será la misma, pero con un significado ligeramente diferente:

Key Description
timestamp Timestamp of the begin of the sampling interval
value Average, lowest (minimum) or highest (maximum) value received in the sampling interval

 
En el caso de que el formato de datos de salida especificado sea 13, 23, 33 o 43, cada elemento de la lista tendrá esta estructura alternativa:

Key Description
timestamp Timestamp of the begin of the sampling interval
low Lowest (minimum) value received in the sampling interval
high Highest (maximum) value received in the sampling interval

 
Si no se ha especificado el huso horario, todas las marcas de tiempo y los intervalos de muestreo se referirán a la zona horaria GMT.

Nota: Se incluirán las mediciones con marca de tiempo al comienzo del intervalo de tiempo. Se excluirá la medición con marca de tiempo al final del intervalo de tiempo.

Ejemplo 1: Necesitamos recuperar la lista de mediciones recibidas del sensor con ID 1517, desde el 10 de octubre de 2015 a las 08:00:00 CEST hasta el 10 de octubre de 2015 a las 10:00:00 CEST, y queremos que nuestro resultado esté en la Zona horaria GMT. Entonces, tenemos que enviar la siguiente solicitud:

< View plain text >
php
  1. [API URL]/measurements?sensorid=1517&amp;begin=1444456800&amp;end=1444464000

 
En la respuesta recibiremos:

< View plain text >
php
  1. {«measurements»:[
  2. {
  3. «timestamp»:«2015-10-10 06:00:01»,
  4. «value»:27.5
  5. },{
  6. «timestamp»:«2015-10-10 06:15:02»,
  7. «value»:27.9
  8. },{
  9. «timestamp»:«2015-10-10 06:30:01»,
  10. «value»:28.1
  11. },{
  12. «timestamp»:«2015-10-10 06:45:02»,
  13. «value»:27.7
  14. },{
  15. «timestamp»:«2015-10-10 07:00:02»,
  16. «value»:27.4
  17. },{
  18. «timestamp»:«2015-10-10 07:15:00»,
  19. «value»:26.9
  20. },{
  21. «timestamp»:«2015-10-10 07:30:01»,
  22. «value»:26.8
  23. },{
  24. «timestamp»:«2015-10-10 07:45:01»,
  25. «value»:27.3
  26. }
  27. ]}

 
Ejemplo 2: Necesitamos recuperar la lista promedio por hora de mediciones recibidas del sensor con ID 1517, desde el 10 de octubre de 2015 a las 08:00:00 CEST hasta el 10 de octubre de 2015 a las 12:00:00 CEST, y queremos que nuestro resultado esté en nuestra zona horaria CEST local. Entonces, tenemos que enviar la siguiente solicitud:

< View plain text >
php
  1. [API URL]/measurements?sensorid=1517&amp;begin=1444456800&amp;end=1444464000

 
En la respuesta recibiremos:

< View plain text >
php
  1. {«measurements»:[
  2. {
  3. «timestamp»:«2015-10-10 08:00:00»,
  4. «value»:27.6
  5. },{
  6. «timestamp»:«2015-10-10 09:00:00»,
  7. «value»:27.7
  8. },{
  9. «timestamp»:«2015-10-10 10:00:00»,
  10. «value»:28.0
  11. },{
  12. «timestamp»:«2015-10-10 11:00:00»,
  13. «value»:27.9
  14. }
  15. ]}

 
Ejemplo 3: necesitamos recuperar la lista de mediciones diarias mínima + máxima recibidas del sensor con ID 1517, desde el 8 de octubre de 2015 a las 00:00:00 CEST hasta el 10 de octubre de 2015 a las 00:00:00 CEST, y queremos que nuestro resultado esté en nuestra zona horaria CEST local. Por eso, tenemos que enviar la siguiente solicitud:

< View plain text >
php
  1. [API URL]/measurements?sensorid=1517&amp;begin=1444255200&amp;end=1444428000&amp;sampling=23&amp;timeoffset=7200

 
En la respuesta recibiremos:

< View plain text >
php
  1. {«measurements»:[
  2. {
  3. «timestamp»:«2015-10-08 00:00:00»,
  4. «low»:25.4
  5. «high»:29.6
  6. },{
  7. «timestamp»:«2015-10-09 00:00:00»,
  8. «low»:25.8
  9. «high»:30.3
  10. }
  11. ]}
Mycelium Networks, SL | 2025. © |