DEXMA API - Documentación

Seguir

Este artículo incluye las siguientes secciones:

 

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

Introducción

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

Documentación técnica de la API v3


Para acceder a la documentación técnica de la API DEXMA, haga clic aquí: DEXMA API v3

Creando una aplicación

Para crear una aplicación, simplemente inicie sesión en su cuenta de desarrollador o superadmin en DEXMA 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:

dexmaapidocumentacio_n-1.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 DEXMA. 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.
 

Ejemplos de llamadas

Obtener una lista de todas mis ubicaciones

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

ae0297a62d7dc329423a6102fa876126ce49b6d75c7a60890ec31b9dd66b8df0.png

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 

 

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)

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)

 

API de inserción de datos

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

Revisa este artículo para aprender a insertar datos en tu cuenta de DEXMA a través del API HTTPS/JSON.

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

¿Te pareció útil este artículo?