DEXMA API - Documentación

Seguir

Este artículo incluye las siguientes secciones:

  1. Documentación API v3
  2. HTTPS/JSON API (inserción de datos)

 

1. Documentación API v3

Esta sección incluye los siguientes apartados:

  1. Introducción
  2. Uso de API v3
  3. Creando una aplicación
  4. Ejemplos de llamadas

1.1 Introducción

Una aplicación se define mediante un conjunto de vistas que se pueden incrustar en DEXCell Energy Manager usando un Iframe. Las aplicaciones se configuran en el Portal para Desarrolladores de DEXCell (se debe solicitar acceso) dentro de "Administración de cuentas" en DEXCell Energy Manager. Para cada aplicación, se proporcionan idclient y un token secreto.
 

1.2 Uso de API v3


Para comenzar a usar la API DEXMA, haga clic aquí: DEXCell API v3

1.3 Creando una aplicación

Para crear una aplicación, simplemente inicie sesión en su cuenta de desarrollador o superadmin en DEXCell Energy Manager y vaya a "Aplicaciones del Market". Hay una lista de todas sus aplicaciones. Puede crear, modificar y publicar aplicaciones.

Para crear una aplicación, simplemente haga clic en "Nueva Market App" y complete el formulario:

18a0980926665711d60fb8dd067710696a2599df63a5a9e0066be74b2c196819.png 
 
 
Nombre: El nombre de la aplicación
Descripción: La descripción para la aplicación.
Imagen: Una imagen a cargar de 200px x 200px que se mostrará en el Market.
Precio: El precio de la aplicación, debe dejarse a 0 para que sea gratis.
Contacto: Una dirección de correo electrónico de contacto.
Software por: El nombre de la empresa desarrolladora de la aplicación.
Visibilidad: Las aplicaciones públicas estarán disponibles para ser instaladas por todos los clientes de DEXCell Energy Manager. Las aplicaciones privadas estarán disponibles solo para sus clientes.
Términos de servicio: Un enlace a los términos de servicio.
URL de instalación: La url para realizar la instalación de la aplicación (más información en developers.dexcell.com)
Vistas: Se pueden definir tantas vistas como se quiera. Para cada vista se debe definir un ícono (opcional), un nombre y una url (la url que se incrustará dentro del iframe). También debe definir dónde aparecerá la vista: Tableros de ubicación, Tableros de zona, Análisis, Configuración.
Permisos: La aplicación debe definir cada tipo de información que desee acceder desde la cuenta del cliente.
 

1.4 Ejemplos de llamadas

1.4.1 Obtener una lista de todas mis ubicaciones

url: https://api.dexcell.com/v3/locations

ae0297a62d7dc329423a6102fa876126ce49b6d75c7a60890ec31b9dd66b8df0.png

1.4.2 Obtener la información específica de una cuenta

url: https://api.dexcell.com/v3/locations/XXX (donde XXX es una de las ID obtenidas en la llamada anterior)

51df1b07e83cb95d52eca1d3186ed9c5c6c38a4503d7c85807cb75afa5a86023.png 

 

1.4.3 Obtenga datos de consumo eléctrico

url: http://api.dexcell.com/v3/readings?device_id=XXXXX&operation=DELTA&parameter_key=EACTIVE&resolution=D&from=2015-05-08T00:00:00&to=2015-05-09T23:59:59​

4c24fdc2426fd0e89c57a414e958a855549b1e9a8a5f64e065a295051de946e2.png 
 


¿Cómo crear la llamada?

http://api.dexcell.com/v3/readings + “?” + todos los parámetros unidos por “&”
- device_id: 3473 (id del dispositivo)
- Operación: DELTA (lecturas delta)
- Parameter_key: EACTIVE (clave del parámetro de Energía Activa)
- Resolución: D (diaria). Otros: FM, TM, QH, HH, H, D, M
- Desde: 2016-05-08T00: 00:00 (a partir de la fecha con el formato AAAA-MM-DDT00:00:00)
- Hasta: 2016-05-10T23: 59:59 (hasta la fecha con el formato YYYY-MM-DDT00:00:00)

1.4.4. Obtenga el coste de electricidad de un dispositivo específico

url:http://api.dexcell.com/v3/cost/electrical/consumption?device_id=XXXX&from=2016-04-01T00:00:00&to=2015-12-31T23:59:59&resolution=M
2a97fc1c3b18e3e296146719ddda56b9c1993006faf86d806775f0303a2cbc07.png

 

¿Cómo crear la llamada?

http://api.dexcell.com/v3/cost/electrical/consumption + “?” + todos los parámetros se unen con "&"
- device_id: 3473 (id del dispositivo)
- Resolución: M (mensual). Otros: FM, TM, QH, HH, H, D, M
- Desde: 2016-05-08T00:00:00 (desde la fecha con el formato YYYY-MM-DDT00:00:00)
- To: 2016-05-10T23:59:59 (hasta la fecha con el formato YYYY-MM-DDT00:00:00)

 

2. HTTPS/JSON API (inserción de datos)

 

DEXCell Energy Manager ofrece una API para insertar datos de aplicaciones externas. Esta API se basa en HTTPS y JSON.

Este artículo explica cómo insertar datos en una cuenta de DEXCell Energy Manager a través de la API HTTPS / JSON.

Entonces, ¿cómo empezar? 

  1. Primero debe crear un concentrador. Un concentrador es un objeto dentro de DEXCell Energy Manager donde puede introducir datos, por lo que necesita tener al menos uno en su cuenta si desea cargar algunas lecturas de energía.
  1. Ahora es el momento de obtener la dirección MAC y el token del concentrador para utilizarlos en la consulta de inserción. Ambas cadenas se encuentran en la página de configuración del concentrador.

 

Enviar datos a DEXCell Energy Manager

 

Parámetros URL

 

Ejemplo de URL:

 https://is3.dexcell.com/readings?source_key=mac-123456789&dexcell_source_token=123456789


Host: is3.dexcell.com

Path: /readings
Método: HTTP POST
Parámetros URL:

  • key: Parámetro obligatorio. Es la dirección MAC de la puerta de enlace o la clave única que identifica la fuente de datos a la que pertenecen los datos.
  • dexcell_source_token: el token de autenticación para cada puerta de enlace. El token se utiliza como una capa de seguridad adicional y DEXMA puede revocarlo si es necesario. Se puede utilizar como un parámetro de URL o en el encabezado de solicitud.

 

Cabecera de la petición (header)

 

Ejemplo de cabecera:

x-dexcell-source-token: 123456789
Content-Type: application/json;charset=utf-8​

 

  • x-dexcell-source-token: el token de autenticación, mencionado anteriormente en los parámetros de URL.
  • Tipo de contenido: application / json; charset = utf-8


Estructura del mensaje

El cuerpo del mensaje http debe contener la colección (matriz) del mensaje que desea insertar.

[{
     "did":"3a",
     "sqn":1,
     "ts":"2014-10-02T10:30:00+02:00",
     "values":[
        {
           "p":401,
           "v":3505
        },
        {
           "p":402,
           "v":5600012
        },
        {
           "p":404,
           "v":123504
        }
     ]
  },
{ ... },
{ ... }
]

​​
La estructura del mensaje es la siguiente:

  • “did” : String // max 25 caracteres; ID local del dispositivo
  • “sqn”: Integer // Número del mensaje; → Utilizado internamente como control de lecturas. Debe ser incremental a partir de uno. Si no puede enviarlo, ajústelo a "1".
  • “ts”: String // Formato basado en el estándar ISO 8601, los disponibles son:
    • YYYY-MM-DDTHH:MM:SSZ → 2014-11-28T17:14:00Z
    • YYYY-MM-DDTHH:MM:SS+HH:MM  2014-11-28T17:14:00+02:00
    • YYYY-MM-DDTHH:MM:SS-HH:MM 2014-11-28T17:14:00-02:00
    • Si desea establecer la hora local, debe agregar el desplazamiento dependiendo de la zona horaria de su ubicación. 
  • “values”: Collection/Array // Contiene todas las lecturas con su id de parámetro y su valor respectivo, la estructura es la siguiente:


Ejemplo 1: envío de datos acumulados a DEXCell Energy Manager


Este ejemplo muestra cómo insertar datos acumulados de energía activa en el dispositivo "3" de la puerta de enlace "123456789".


De acuerdo con la lista de parámetros, los datos deben introducirse en el parámetro 402.

URL sólo:


URL y cabecera:

https://is3.dexcell.com/readings?source_key=mac-123456789
x-dexcell-source-token:123456789


Cuerpo del mensaje: 

[{
     "did":"3",
     "sqn":1,
     "ts":"2014-10-02T10:30:00+00:00",
     "values":[
        {
           "p":402,
           "v":1250.0
        }
        ]
  },
  {
     "did":"3",
     "sqn":2,
     "ts":"2014-10-02T10:45:00+00:00",
     "values":[
        {
           "p":402,
           "v":1280
        }
        ]
  },
  {
     "did":"3",
     "sqn":3,
     "ts":"2014-10-02T11:00:00+00:00",
     "values":[
        {
           "p":402,
           "v":1298.3
        }
        ]
  }
]

 


Ejemplo 2: envío de datos de intervalo a DEXCell Energy Manager

 

Este ejemplo muestra cómo insertar datos de energía activa de media hora en el dispositivo "5" de la puerta de enlace "123456789".
De acuerdo con la lista de parámetros,
 los datos deben introducirse en el parámetro 40261.

​URL sólo:


URL y cabecera:

https://is3.dexcell.com/readings?source_key=mac-123456789
x-dexcell-source-token:123456789

 

Cuerpo del mensaje:

[{
     "did":"5",
     "sqn":1,
     "ts":"2014-10-02T10:30:00+00:00",
     "values":[
        {
           "p":40261,
           "v":30.0
        }
        ]
  },
  {
     "did":"5",
     "sqn":2,
     "ts":"2014-10-02T10:45:00+00:00",
     "values":[
        {
           "p":40261,
           "v":18.3
        }
        ]
  }
]


Nota importante: Para los datos de intervalo, DEXCell Energy Manager utiliza la convención de trazar la energía consumida durante el intervalo en la primera marca de tiempo. Por ejemplo, si de 20:00h a 20:30h, la energía consumida es de 52 kWh, los datos deben introducirse en la marca de tiempo de 20:00h.


Ejemplo 3: envío de datos instantáneos a DEXCell Energy Manager

 

Este ejemplo muestra cómo insertar datos instantáneos como la temperatura (301) o la potencia (401) en el dispositivo "7" de la puerta de enlace "123456789".

​URL sólo:


URL y cabecera:

https://is3.dexcell.com/readings?source_key=mac-123456789
x-dexcell-source-token:123456789

 

Cuerpo del mensaje:

[{
     "did":"7",
     "sqn":1,
     "ts":"2014-10-02T10:30:00+00:00",
     "values":[
        {
           "p":301,
           "v":25.2
        },
        {
           "p":401,
           "v":2540
        }
        ]
  },
  {
     "did":"7",
     "sqn":2,
     "ts":"2014-10-02T10:45:00+00:00",
     "values":[
        {
           "p":301,
           "v":25.8
        },
        {
           "p":401,
           "v":1890
        }
        ]
  }
]

 

Para cualquier ayuda adicional, por favor póngase en contacto con support@dexma.com

Usuarios a los que les pareció útil: 0 de 0

Comentarios

0 comentarios

Inicie sesión para dejar un comentario.