Como conectarse a la API de MonitorPro
La API de MonitorPro se puede utilizar para el reporte posterior de los datos de MonitorPro. Por el momento, su función se limita sólamente a presentar los datos existentes en la base de datos, y no a realizar inserciones o actualizaciones de la misma, con el fin de garantizar la continuidad de la auditoría y de 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 que desea generar la salida. En múltiples implementaciones de bases de datos, deberá confirmar esto desde tblDatabase en la base de datos MP5WebGateway.
- Reemplace {reportName} con cualquiera de los nombres de los reportes (stored procedures) de la lista que se muestra al final de este artículo.
- Reemplace {selectionId} con el selectionID que desea utilizar como base de su qurey. Para obtenerlo, deberá buscarlo en tblSelection utilizando sSelectionStoreName (el nombre común conocido por el usuario) como identificador.
- Como parte de la llamada, el token de portador (utilizado para autenticar) debe pasarse en el encabezado de Autorización, es decir, Autorización: Portador <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 Disponibles
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_006a_Data_Extended_ComplianceGridsOnlyBroken
- 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