Introduction to the MonitorPro Importer API aka Scheduled Importer
Introduction
An API Importer, or a Scheduled Importer, allows users to connect to several API endpoints to return data for import. A library of endpoints are supported with the ability to add more. If you have a specific requirement, then contact your Account Manager or support@ehsdata.com
Once configured, these importers automatically retrieve data from an external system at a timed interval.
Each Importer will require the setup of the specific parameters. The specific API provider stipulates the number and type of parameters. Some of the below are generic data providers (such as weather in your area). Others are explicitly provided for users to access their data stored in the cloud after being collected onsite (such as level loggers or site-based weather stations). Some endpoints are secured, and the traffic is encrypted. These may require users to obtain a token, which MonitorPro then uses to authenticate to the service.
The following list includes examples of some of those available, the details of which are correct at the time of writing.
Beemetry - https://www.beemetry.com/
This importer is used to obtain weather data
Parameters
- Url - The custom endpoint to the data. The data returned is configured by Beemetry.
- Timezone - The timezone for the dates being retrieved.
H2 Lab - https://h2lab.ca/
This importer is used to obtain lab results from the H2 Lab
Parameters
- Url - The url to get the results from e.g. https://client.h2lab.ca/api/Results
- Username - h2lab account name
- Password - h2 lab account password
H2 Lab Lixiviation - https://h2lab.ca/
This importer is used to obtain lab results. Variables can be excluded from the import using an exclusion file. The lixiviation logic takes a lixiviation variable (which ends in lix.) and creates a SPLP/TCLP/CTEU-9 output instead.
Parameters
- Url - The url to get the results from e.g. https://client.h2lab.ca/api/Results
- Username - h2lab account name
- Password - h2 lab account password
- Exclusion File - Location of the exclusion file containing variables to exclude when importing data
Met Office Canada - https://www.canada.ca/en.html
This is used to obtain weather data from the Canadian Met Office. The data is obtained from https://api.weather.gc.ca/collections/climate-daily/items
Parameters
- Id - The identification of the weather station to get the data from
- Parameters - A comma separated list of variables to retrieve. The available options are:
CLIMATE_IDENTIFIER
COOLING_DEGREE_DAYS
COOLING_DEGREE_DAYS_FLAG
DIRECTION_MAX_GUST
DIRECTION_MAX_GUST_FLAG
HEATING_DEGREE_DAYS
HEATING_DEGREE_DAYS_FLAG
LOCAL_DATE
LOCAL_DAY
LOCAL_MONTH
LOCAL_YEAR
MAX_REL_HUMIDITY
MAX_REL_HUMIDITY_FLAG
MAX_TEMPERATURE
MAX_TEMPERATURE_FLAG
MEAN_TEMPERATURE
MEAN_TEMPERATURE_FLAG
MIN_REL_HUMIDITY
MIN_REL_HUMIDITY_FLAG
MIN_TEMPERATURE
MIN_TEMPERATURE_FLAG
PROVINCE_CODE
SNOW_ON_GROUND
SNOW_ON_GROUND_FLAG
SOURCE
SPEED_MAX_GUST
SPEED_MAX_GUST_FLAG
STATION_NAME
STN_ID
TOTAL_PRECIPITATION
TOTAL_PRECIPITATION_FLAG
TOTAL_RAIN
TOTAL_RAIN_FLAG
TOTAL_SNOW
TOTAL_SNOW_FLAG
NASA Power - https://power.larc.nasa.gov/
This is used to obtain weather data.
Parameters
- GetHourly - When True hourly data is retrieved. When False daily data is retrieved
- Latitude - Latitude for the location to get data for
- Longitude - Longitude for the location to get data for
- Parameters - The variables to retrieve. A full list is available here https://power.larc.nasa.gov/#resources