For the complete documentation index, see llms.txt. This page is also available as Markdown.

Register User

User registration and verification

Register a new user or create new access token for existing user

post
/register

Requests a verification code to be emailed. The verification code is then entered to /verify to get the access token. The code is single-use and valid for 60 minutes. To protect against spam, this endpoint is rate limited.

Body
emailstring · emailRequired
Responses
200

Verification code emailed successfully

application/json
resultstring · enumRequiredExample: successPossible values:
post/register
POST /register HTTP/1.1
Host: network.ruuvi.com
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "email": "otso+docs@ruuvi.com"
}
{
  "result": "success",
  "data": {
    "email": "otso+docs@ruuvi.com"
  }
}

Verify a user's email with a verification code to get an access token

get
/verify

Verify a user's email with a verification code to get an access token. The code is single-use and valid for 60 minutes. Access tokens remain valid while actively used and are removed after approximately 180 days of inactivity, unless revoked earlier.

Query parameters
tokenstringRequiredExample: BCDF
Responses
200

Verification code successful

application/json
resultstring · enumRequiredExample: successPossible values:
get/verify
GET /verify?token=text HTTP/1.1
Host: network.ruuvi.com
Accept: */*
{
  "result": "success",
  "data": {
    "email": "otso+docs@ruuvi.com",
    "accessToken": "753133/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "newUser": true
  }
}

Last updated