API
      Revenir à l'accueil
      1. Base de connaissances et manuel
      2. L'intégration
      3. API

      MonitorPro API

      Comment se connecter à l'API MonitorPro

      L'API MonitorPro peut être désormais utilisé pour rapporter les données de MonitorPro. Pour le moment, sa fonction est limitée aux données sortantes et non aux insertions ou aux mises à jour, afin d'assurer la continuité de l'audit et de l'accréditation MCERTS.

      Création d'un token API

      Naviguez vers la page Administration, puis cliquez sur le lien Token API.

      Sur la page qui apparaît, cliquez sur le bouton Générer pour générer un nouveau token.

      Une boîte de dialogue contenant le token généré s'affiche. Cliquez sur le lien situé à droite pour copier la valeur dans le presse-papiers.

      Accès à l'API à l'aide du token généré

      Pour accéder à l'API, modifiez l'url suivante.

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

      • Définissez votre emplacement de MP-Web
      • Définissez le protocole selon la configuration de votre site web, HTTP ou HTTPS. HTTPS est recommandé.
      • Remplacez {databaseId} par l'ID de la base de données à partir de laquelle vous souhaitez obtenir des résultats. Dans les implémentations de bases de données multiples, vous devrez le confirmer à partir de tblDatabase dans la base de données MP5WebGateway.
      • Remplacez {reportName} par l'un des noms de rapport de la liste ci-dessous.
      • Remplacez {selectionId} par l'ID de selection que vous souhaitez utiliser comme base de votre requête. Pour l'obtenir, vous devrez le rechercher dans tblSelection en utilisant le sSelectionStoreName (le nom commun connu de l'utilisateur) comme identifiant.
      • Dans le cadre de la requête, le token du détenteur (utilisé pour l'authentification) doit être transmis dans l'en-tête d'autorisation, c'est-à-dire Authorization : Bearer <token>

      Voir l'exemple ci-dessous utilisant POSTMAN.

      Révoquer le token

      Pour révoquer le token généré, naviguez jusqu'à la page Administration -> API Token utilisée initialement, et cliquez sur le bouton Revoke Token (Révoquer le token).

      Rapports disponibles

      Les rapports suivants sont 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_006c_Data_Extended_AllComplianceTypes_Incl_Metadata.
      • 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