This document summarizes the APIs for uHoo Business (\"Business\") solution. Note that our server would reject any request from Postman for security purpose, please implement and test the endpoint logic directly on your server / cloud.
\nTo use the APIs, create a unique client ID using the web dashboard then use it to generate the access token. If you haven't done so, follow the steps below.
\nLogin https://web.getuhoo.com
\nTap the user icon in the top right corner, and go to the 'My Account' page
\nScroll down to the 'API' section, tap 'Generate Client ID', and enter your account password to get the client ID for your application
\nUse the /generatetoken endpoint to generate an access token, and use it to get the device list or data
\nCopy-paste the client ID from web dashboard
\n"}]},"url":"https://api.uhooinc.com/v1/generatetoken","description":"Use this API to generate the access token and pass it as a bearer token in the header when calling the /devicelist and /devicedata endpoints. Each access token expires every 600 seconds (i.e. 10 minutes). When an API returns the HTTP status code 403 (forbidden error), generate a new access token and try to access the target resources again. When a new access token is created, our system would automatically invalidate the old access token, thus API calls that use the old token would return the HTTP status code 401 (unauthorized error).
\nAssign \"access_token\" from /generatetoken endpoint
\n"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://api.uhooinc.com/v1/devicelist","description":"Use this API to get the device MAC addresses for your account and pass it as an input parameter to the POST /devicedata endpoint. We recommend to call it once per hour to ensure information is up to date, especially when you add new devices to the account. When the API count has reached the daily limit, any subsequent API call would return the HTTP status code 400 until the count is reset at midnight UTC time.
\nArray of device objects
\ndeviceName: Device name
\nmacAddress: Device MAC address or IMEI for the SIM version of uHoo Aura
\nserialNumber: Device serial number
\nfloorNumber: Device floor number
\nroomName: Device room name
\ntimezone: Device timezone. Note that it doesn't account for daylight saving time, please refer to the utcOffset parameter if you want to convert the data timestamp into the local date and time.
\nutcOffset: Actual offset from UTC in +HH:mm or -HH:mm. Use this parameter to convert the data timestamp into the local date and time.
\nssid: Wi-Fi network name
\nAssign \"access_token\" from /generatetoken endpoint
\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"macAddress","value":"xxxxxxxxxxxx","type":"text","description":"Assign the \"macAddress\" parameter from /devicelist endpoint
\n"},{"key":"mode","value":"minute","type":"text","description":"See notes on \"mode\" parameter
\n"},{"key":"prevDateTime","value":"YYYY-MM-DD hh:mm:ss","type":"text","description":"See notes on the optional \"prevDateTime\" parameter
\n","disabled":true},{"key":"limit","value":"","description":"See notes on the optional \"limit\" parameter
\n","type":"text","disabled":true},{"key":"timestampStart","value":"","description":"See notes on the optional \"timestampStart\" parameter
\n","type":"text","disabled":true},{"key":"timestampEnd","value":"","description":"See notes on the optional \"timestampEnd\" parameter
\n","type":"text","disabled":true}]},"url":"https://api.uhooinc.com/v1/devicedata","description":"Use this API to get the data of any device. When the API count has reached the daily limit, any subsequent API call would return the HTTP status code 400 until the count is reset at midnight UTC time.
\nCall the API every minute to match the data frequency of the devices.
\nMake use of the optional parameters to get data from any date and time.
\nRead the sensor keys from the sensorlist object and use them to get the device data from the data object, this allows your system to support all sensor configuration of the uHoo Aura without making modifications in the future.
\nmacAddress
\nmode
\nSupported values: minute / hour / day
\nmode = minute
\nReturn the most recent data of a device, or the HTTP status code 404 if device has no data.
\nTo get more than 1 data point in one call, specify the number using the limit parameter.
\nThere are 2 ways to retrieve data from previous hours. Option 1 is to specify the starting date and time using the prevDateTime parameter. Option 2 is to specify the time stamp range using the timestampStart and timestampEnd parameters.
\nmode = hour
\nmode = day
\nlimit
\nSupported values: 5 / 15 / 30. Only valid when mode = minute.
\nExample: if limit is set to 15, the API would return data sent within the last 15 minutes assuming the device is online.
\nWhen limit is specified, the API count would increase by the same number instead of by 1 for every API call.
\nprevDateTime
\nSupports the ISO 8601 no T format: YYYY-MM-DD HH:mm:ss
\nDate and time is based on UTC, which is independent of the device location and time zone.
\nIf mode = hour
\nSpecify date and time in YYYY-MM-DD HH:MM:00 format
\nExample: If prevDateTime = 2023-01-01 08:30:00, API returns data between \"2023-01-01 08:30:00\" and \"2023-01-01 09:29:59\" in UTC.
\nIf prevDateTime is not specified, the API would return any data sent within the last 60 minutes, or return an error if the device is offline.
\nIf mode = day
\nSpecify date and time in YYYY-MM-DD 00:00:00 format
\nExample: If prevDateTime = 2023-01-01 00:00:00, API returns data between \"2023-01-01 00:00:00\" and \"2023-01-01 23:59:59\" in UTC.
\nIf prevDateTime is not specified, the API would return any data sent within the last 24 hours, or return an error if the device is offline.
\ntimestampStart and timestampEnd
\nSupports the Unix timestamp in number of seconds.
\nReturn data between timestampStart (inclusive) and timestampEnd (exclusive).
\ndata object
\nReturn data in key-value pair format.
\nSome keys are only supported by the uHoo Aura, please refer to the third column in the table below.
\nusersettings object
\nsensorlist object
\nReturn the sensor list in key-value pair format for the specified time period. See the data object above for more details.
\nThis list always returns 9 sensors for any uHoo Smart Air Monitor, it returns up to 15 sensors for the uHoo Aura depending on the sensor configuration of the module A.
\ncount
\nReturn the number of API calls made since 12AM UTC today. Use it to monitor the API usage over time and identify redundant calls.
\nThe API count is reset at 12AM UTC every day.
\nAssign \"access_token\" from /generatetoken endpoint
\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"macAddress","value":"xxxxxxxxxxxx","type":"text","description":"Assign the \"macAddress\" parameter from /devicelist endpoint
\n"}]},"url":"https://api.uhooinc.com/v1/networkinfo","description":"Use this API to get the network information of any device. When the API count has reached the daily limit, any subsequent API call would return the HTTP status code 400 until the count is reset at midnight UTC time.
\nmacAddress
\nReturn data in key-value pair format.
\nNot all keys are supported by the 3 device types (uHoo Aura Wi-Fi / Aura SIM / Smart Air Monitor), please refer to the third and fourth columns in the table below.
\n