Volver a la documentación

📊 Endpoints Mendix (Electricidad)

Conjunto de endpoints de consumo eléctrico preparados para ser consumidos directamente por flujos de integración con Mendix. Algunos devuelven XML (consumos mensuales) y otros JSON (agregados anuales).

🔐 Autenticación

Todos los endpoints aceptan dos esquemas (require_any_auth):

🌐 Ventana de datos

Los endpoints de esta página trabajan sobre los últimos 12 meses naturales completos disponibles en SIPS para el CUPS. La fuente de datos es neuro360.es/api/apiSips + las potencias contratadas (SIPS técnicos).


GET /sips_datos_consumos_mendix/<cups>

📊 Consumos Mensualizados (Mendix · XML)

Devuelve el consumo eléctrico total por mes natural durante los últimos 12 meses en formato XML compatible con Mendix. Cada nodo agrega los consumos de todos los períodos (P1..P6) en un único valor ConsumoWh.

Parámetros de Ruta

ParámetroTipoRequeridoDescripción
cups string Requerido Código CUPS del punto de suministro eléctrico.

Cabeceras de la respuesta

Campos del XML

NodoTipoDescripción
CUPSstringCUPS consultado, normalizado.
codigoTarifaATRstringTarifa de acceso en vigor (2.0TD, 3.0TD, 6.1TD, ...).
MesintNúmero de mes (1-12).
DiasPeriodointDías con datos dentro del mes.
ConsumoWhintConsumo total del mes en Wh (suma P1..P6).
MesRefstringAño + mes en formato YYYYMM.
EditboolSiempre true: marca el registro como editable en Mendix.

✅ Ejemplo de respuesta (200)

<?xml version="1.0" encoding="utf-8"?>
<ConsumosMensualizadosSIPs>
    <ConsumosMensualizadosSIPS>
        <CUPS>ES0031405678912345AB1F</CUPS>
        <codigoTarifaATR>2.0TD</codigoTarifaATR>
        <Mes>1</Mes>
        <DiasPeriodo>31</DiasPeriodo>
        <ConsumoWh>312450</ConsumoWh>
        <MesRef>202501</MesRef>
        <Edit>true</Edit>
    </ConsumosMensualizadosSIPS>
</ConsumosMensualizadosSIPs>

❌ Respuestas de error

💻 Ejemplo cURL

curl -X GET "https://api.imaginaenergia.com/sips_datos_consumos_mendix/ES0031405678912345AB1F" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Accept: application/xml"

GET /sips_datos_consumos_periodos_mendix/<cups>

⚡ Consumos Mensualizados por Períodos (Mendix · XML)

Idéntico al anterior pero desglosando el consumo en cada uno de los 6 períodos tarifarios (ConsumoWhP1..ConsumoWhP6). Útil para facturación detallada en tarifas 3.0TD / 6.1TD.

Campos del XML

NodoTipoDescripción
CUPSstringCUPS normalizado.
codigoTarifaATRstringTarifa ATR en vigor.
MesintMes natural (1-12).
DiasPeriodointDías con datos en el mes.
ConsumoWhP1..ConsumoWhP6intEnergía activa consumida por período (Wh).
MesRefstringYYYYMM.
EditboolSiempre true.

✅ Ejemplo de respuesta (200)

<?xml version="1.0" encoding="utf-8"?>
<ConsumosMensualizadosSIPs>
    <ConsumosMensualizadosSIPS>
        <CUPS>ES0031405678912345AB1F</CUPS>
        <codigoTarifaATR>3.0TD</codigoTarifaATR>
        <Mes>2</Mes>
        <DiasPeriodo>28</DiasPeriodo>
        <ConsumoWhP1>120000</ConsumoWhP1>
        <ConsumoWhP2>95000</ConsumoWhP2>
        <ConsumoWhP3>72000</ConsumoWhP3>
        <ConsumoWhP4>0</ConsumoWhP4>
        <ConsumoWhP5>0</ConsumoWhP5>
        <ConsumoWhP6>0</ConsumoWhP6>
        <MesRef>202502</MesRef>
        <Edit>true</Edit>
    </ConsumosMensualizadosSIPS>
</ConsumosMensualizadosSIPs>

GET /sips_datos_anuales_mendix/<cups>

📅 Consumos Anuales por Períodos (Mendix · JSON)

Resumen consolidado de los últimos 12 meses para el CUPS. Combina:

Campos destacados de la respuesta

CampoTipoDescripción
CUPSstringCUPS consultado.
TarifaATRstringTarifa ATR en vigor.
tarifa_atr_mappedstringTarifa normalizada para los motores internos.
Provincia_PS / CP_PSstringProvincia y código postal del punto de suministro.
sistema_electricostringZona eléctrica derivada de la provincia (península, Baleares, Canarias, ...).
potenciasContratadasEnWP1..6numberPotencia contratada por período (W).
potenciasContratadasEnWP1_kw..6_kwnumberEquivalente en kW (derivado).
CAE_P1..CAE_P6numberConsumo anual por período (Wh).
PCT_P1..PCT_P6number% del consumo anual por período.
ConsumoAnualWhnumberSuma de CAE_P1..CAE_P6 (Wh).
consumoAnual_kwhnumberConsumo anual total en kWh.
consumoAnualP1_kwh..P6_kwhnumberConsumo anual por período en kWh.

✅ Ejemplo de respuesta (200)

{
  "CUPS": "ES0031405678912345AB1F",
  "TarifaATR": "2.0TD",
  "tarifa_atr_mapped": "2.0TD",
  "Provincia_PS": "28",
  "CP_PS": "28013",
  "sistema_electrico": "peninsula",
  "potenciasContratadasEnWP1": 4600,
  "potenciasContratadasEnWP2": 4600,
  "potenciasContratadasEnWP1_kw": 4.6,
  "potenciasContratadasEnWP2_kw": 4.6,
  "CAE_P1": 1200000,
  "CAE_P2": 950000,
  "CAE_P3": 720000,
  "CAE_P4": 0, "CAE_P5": 0, "CAE_P6": 0,
  "PCT_P1": 41.8,
  "PCT_P2": 33.1,
  "PCT_P3": 25.1,
  "ConsumoAnualWh": 2870000,
  "consumoAnual_kwh": 2870.0,
  "consumoAnualP1_kwh": 1200.0,
  "consumoAnualP2_kwh": 950.0,
  "consumoAnualP3_kwh": 720.0
}

GET /sips_datos_anuales_mendix_por_meses/<cups>

📈 Consumo Anual + Detalle Mensual (JSON)

Misma estructura que /sips_datos_anuales_mendix pero incorporando además el desglose mensual de los últimos 12 meses. Es el endpoint utilizado por la SPA para pintar gráficos de consumo.

Junto a los campos anuales, la respuesta añade una lista (o conjunto de claves derivadas, según el cliente Mendix) con los consumos mensuales por período listos para representación gráfica.

ℹ️ Cuándo usar uno u otro:
  • /sips_datos_anuales_mendix → cuando solo necesitas el agregado anual.
  • /sips_datos_anuales_mendix_por_meses → cuando además quieres pintar gráficos o calcular curvas mensuales.

GET /sips_datos_anuales_mendix_pre/<cups>

🧪 Consumos Anuales (Mendix · PRE)

Variante del endpoint anual JSON pensada para el entorno PRE de Mendix. Internamente invoca la misma función que /sips_datos_anuales_mendix/<cups> y la respuesta tiene exactamente la misma estructura.

Se mantiene como ruta separada para que el entorno PRE pueda evolucionar de forma independiente sin afectar a las integraciones productivas. Si tu flujo Mendix de PRO está apuntando aquí, debería migrarse a la ruta sin sufijo.