User API
Ruuvi Network (Serverless) user facing API. Lifecycle: in production
User API uses a JSON based API to allow users to register, secure and edit their information as well as claim and share sensors, retrieve sensor data and alter their subscription details.
For example, if the body parameter in the sections below refers to an email field, the corresponding JSON payload would look like this:
{
"email": "<YOUR VALUE>"
}
All authenticated queries are ratelimited to 4 * MAX_SENSORS_OWNED + 0.1 * MAX_HISTORY_DAYS per minute. For example user with Basic plan has maximum of 90 days of history on 25 sensors and can make up to 109 queries per minute. The throtteled response has response code of 429 and payload of:
{
result: 'error',
error: 'Too many requests.',
code: 'ER_THROTTLED'
}
post
https://network.ruuvi.com
/register
Register User or Reset Token
get
https://network.ruuvi.com
/verify
Verify Account
post
https://network.ruuvi.com
/request-delete
Request deletion of account
get
https://network.ruuvi.com
/verify-delete
Verify account deletion operation
post
https://netowrk.ruuvi.com
/claim
Claim a sensor for user
post
https://network.ruuvi.com
/unclaim
Unclaim a sensor from your user
get
https://network.ruuvi.com
/sensors
Get your sensors
get
https://network.ruuvi.com
/sensors-dense
Get your sensors with calibration data, latest measurement, and alerts settings
get
https://network.ruuvi.com
/user
Get User Info
get
https://network.ruuvi.com
/get
Get Sensor data
post
https://network.ruuvi.com
/update
Update Sensor metadata
post
https://network.ruuvi.com/
upload
Upload Sensor image (part 1)
put
<URL FROM part 1>
Upload the actual image
get
https://network.ruuvi.com
/settings
Get User Settings
post
https://network.ruuvi.com
/settings
Update user setting
post
https://network.ruuvi.com
/alerts
Create and update Alerts
get
https://network.ruuvi.com
/alerts
Get alerts
get
https://network.ruuvi.com
/check
Check if a sensor with given MAC address is claimed by someone
post
https://network.ruuvi.com/
contest-sensor
Contest ownership of a sensor
post
https://network.ruuvi.com/
subscription
Claim a subscription by a code
get
https://network.ruuvi.com
/subscription
Get subscription history
post
https://network.ruuvi.com/
push-register
Register a push notification token for user
post
https://network.ruuvi.com/
push-unregister
Remove a push notification token for user
get
https://network.ruuvi.com/
push-list
Get a list of tokens associated with user account
Last modified 2mo ago