Ir directamente al contenido
Español
Contáctenos
Ir a ehsdata.com
  • No hay sugerencias porque el campo de búsqueda está vacío.

API de MonitorPro - Introducción

Cómo conectarse a la API de MonitorPro

La API de MonitorPro se puede utilizar para reportar y/o visualizar los datos de MonitorPro en sistemas externos. Por el momento, su función se limita sólamente a presentar/visualizar los datos existentes en la base de datos, y no a realizar inserciones o actualizaciones de la misma. Esto es con el fin de garantizar la auditoría de datos y la acreditación MCERTS.

Crear un Token de API

Navegue hacia la página de Administración y luego haga clic en el enlace API Token.

En la ventana emergente, haga clic en el botón "Generar" para crear un nuevo token.

Se mostrará un cuadro de diálogo que mostrará el token generado. Haga clic en el enlace del lado derecho para copiar el valor en el portapapeles.

Acceder a la API mediante el Token generado

Para acceder a la API, modifique la siguiente URL.

https://your.domain.com/api/{databaseId}/reporting/{reportName}/{selectionId}

  • Establezca su ubicación local de MP-Web
  • Establezca el protocolo de acuerdo con la configuración de su sitio web, HTTP o HTTPS. Se recomienda HTTPS.
  • Reemplace {databaseId} con el databaseID de su base de datos desde la cual desea generar la salida. En caso de existir múltiples bases de datos, deberá verificar el ID correspondiente desde la tabla tblDatabase de la base de datos MP5WebGateway.
  • Reemplace {reportName} con cualquiera de los nombres de los reportes (stored procedures) detallados en la lista que se muestra al final de este artículo.
  • Reemplace {selectionId} con el ID del Dataset que desea utilizar para su consulta. Puede obtener el ID desde la tabla tblSelection, utilizando para ello el nombre del Dataset asignado por el usuario (puede ver el nombre del dataset en la columna sSelectionStoreName).

  • Como parte de la llamada, el Token de Portador (Bearer Token), utilizado para la autenticación, debe colocarse en el encabezado de autorización, por ejemplo, Authorization: Bearer <token>

    Vea el siguiente ejemplo utilizando POSTMAN.

Revocar un Token

Para revocar el token generado, vaya a la página Administración -> API Token utilizada inicialmente y haga clic en el botón Revocar Token.

Reportes/Llamadas de API Disponibles (API Report Calls)

Los datos consultados a través de la API están disponibles gracias a procedimientos almacenados diseñados específicamente para este fin, los cuales combinan y convierten las tablas comunes de la base de datos en información útil para el usuario. Esto a menudo significa que no es necesario comprender la compleja estructura de los datos ni las claves foráneas (foreign keys) presentes en las múltiples tablas normalizadas de la base de datos de MonitorPro.

Cada reporte tiene disitinta complejidad, desde tablas de datos simples hasta tablas de cumplimiento más complejas con sus metadatos asociados.

Los siguientes reportes o procedimientos almacenados (stored procedures) se encuentran disponibles:

  • report_001_SelectedData
  • report_001_SelectedLocations
  • report_003_SelectedVariables
  • report_003a_SelectedSources
  • report_003b_SelectedSampleTypes
  • report_005_Data_Basic
  • report_005_Data_Basic_AdditionalFields
  • report_005v_Data_Basic_VariableOrder
  • report_005vs_Data_Basic_VariableSamplePointOrder
  • report_005vs_Data_Basic_VariableSamplePointOrderPreordered
  • report_005vsd_Data_Basic_VariableSamplePointOrderDummy
  • report_005x_Data_Deleted
  • report_006_Data_Extended
  • report_006a_Data_Extended_ComplianceGridsOnly
  • report_006avs_Data_Extended_ComplianceGridsOnly_VariableSamplePointOrder
  • report_006b_Data_Extended_AllComplianceTypes
  • report_006b_Data_Extended_CompliancePivot
  • report_006b1_Data_Extended_AllComplianceTypes_ImportanceWarning
  • report_006b2_Data_Extended_AllComplianceTypes_ImportanceInternal
  • report_006b3_Data_Extended_AllComplianceTypes_ImportanceBreach
  • report_006b4_Data_Extended_AllComplianceTypes_ImportanceHighPriorityBreach
  • report_007_Exceedences
  • report_007a_Exceedences_ComplianceGridOnly
  • report_007b_Exceedences_AllComplianceTypes
  • report_008_Data_Basic_By_Group
  • report_008_Data_Basic_by_Grp
  • report_008x_Data_Basic_By_Group_Extended
  • report_009_Data_Basic_By_Suite
  • report_010_Aggregates
  • report_010_DataImportedYesterday_Detail
  • report_010_DataImportedYesterday_DetailWithThresholds
  • report_010a_Aggregates_ComplianceGridsOnly
  • report_010b_Aggregates_AllComplianceTypes
  • report_011_Extended_Incl_Suites
  • report_011a_Extended_Incl_Suites_ComplianceGridsOnly
  • report_011b_Extended_Incl_Suites_AllComplianceTypes
  • report_012_Exceedences_Raw_Data
  • report_012a_Exceedences_Raw_Data_ComplianceGridsOnly
  • report_012b_Exceedences_Raw_Data_AllComplianceTypes
  • report_013_Data_Basic_Monitoring_Performance_Report
  • report_DailyPreviousFiveDaySum
  • report_DMR
  • report_MonthlyMaxAnnualRollingAverage

Hay Reportes API adicionales que presentan las tablas en bruto. No se recomienda utilizarlos a menos que el usuario comprenda el esquema básico de la base de datos y esté llevando a cabo un proyecto para replicar las tablas directamente y, a continuación, construir sus propias capas de negocio sobre ellas para presentar los datos en tableros o informes posteriores. 

Advertencia

Tenga en cuenta que todas las tablas de MonitorPro tienen marcas de borrado (deleted flags) y marcas de estado (status flags), las cuales no solo se refieren a los datos en sí, sino también a los objetos asociados. Es muy posible que los datos de las tablas en estos resultados hayan sido eliminados activamente por los usuarios en el sistema o eliminados en virtud de la eliminación de uno de los objetos asociados. Las capas de negocio posteriores deben tener esto en cuenta al extraer datos de las tablas. De no hacerlo, se presentarán datos no válidos, desactualizados o que hayan sido modificados posteriormente en el sistema. 

Una de las siguientes llamadas devuelve los datos restringidos por el rango de fechas del Dataset/lSelectionID y la otra por un periodo fijo de 24 horas. 

  • report_102_tblDataSelected
  • report_101_tblDataLast24Hours

Las siguientes llamadas requieren especificar el ID del Datatset (lSelectionID) a través de la API. En caso de no especificarlo, la llamada devolverá el contenido completo de la tabla. 

  • report_111_tblLabRef
  • report_112_tblSample
  • report_113_tblSampleType
  • report_121_tblSite
  • report_122_tblSamplePoint
  • report_123_tblSamplePointType
  • report_124_tblLithology
  • report_131_tblSource
  • report_141_tblVariable
  • report_142_tblUnit
  • report_151_tblUser
  • report_201_tblThreshold
  • report_202_tblThresholdInstance
  • report_203_tblThresholdLevel
  • report_204_tblThresholdRule
  • report_211_tblThresholdExceedance
  • report_204_tblThresholdRule

Otros Artículos Relacionados:

Conectar Excel con MonitorPro 

Conectar Power BI con Monitor Pro