Register User

User registration and verification

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

post

https://network.ruuvi.comhttps://testnet.ruuvi.com

/register

Requests a verification code to be emailed. The verification code is then entered to /verify to get the access token. To protect against spam, this endpoint is rate limited.

Body

application/json

emailstring · emailRequired

Responses

200

Verification code emailed successfully

application/json

400

INVALID - Missing or malformed fields Email missing or not valid format

application/json

429

Too many requests - Rate limit exceeded Rate limits apply per email address, IP address and total. Try again later.

application/json

post

/register

HTTPcURLJavaScriptPython

POST /register HTTP/1.1
Host: network.ruuvi.com
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "email": "[email protected]"
}

{
  "result": "success",
  "data": {
    "email": "[email protected]"
  }
}

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

get

https://network.ruuvi.comhttps://testnet.ruuvi.com

/verify

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

Query parameters

tokenstringRequiredExample: BCDF

Responses

200

Verification code successful

application/json

400

INVALID - Missing or malformed fields Code missing

application/json

403

Forbidden - Verification code invalid or expired

application/json

429

Too many requests - Rate limit exceeded Rate limits apply per IP address and total. Try again later.

application/json

get

/verify

HTTPcURLJavaScriptPython

GET /verify?token=text HTTP/1.1
Host: network.ruuvi.com
Accept: */*

{
  "result": "success",
  "data": {
    "email": "[email protected]",
    "accessToken": "753133/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "newUser": true
  }
}