POST /api/register

​

Overview

1. The entry key is marked as claimed
2. An ownership record is created linking the device to the user
3. The user bucket and structure bucket are pushed to the device, completing the pairing dialog on-screen

​

Endpoint

POST http://your-server:8082/api/register

​

Request

{
  "code": "A3XR7M2",
  "userId": "homeassistant"
}

​

Response

​

Success (200 OK)

{
  "success": true,
  "serial": "02AB01AC012345678",
  "message": "Device 02AB01AC012345678 registered to homeassistant"
}

​

Failure — Invalid/Expired/Already Claimed (200 OK)

{
  "success": false,
  "message": "Invalid, expired, or already claimed entry key"
}

​

Error (400 Bad Request)

{
  "success": false,
  "message": "Invalid entry code format. Must be exactly 7 alphanumeric characters."
}

{
  "success": false,
  "message": "Missing required fields: code, userId"
}

​

Pairing Completion

1. user.{userId} bucket with {"name": "{userId}"} — this is what triggers the pairing screen to dismiss on the device
2. structure.{structureId} bucket with {"name": "Home", "devices": [serial]} — establishes the home association

​

Examples

curl -X POST http://your-server:8082/api/register \
  -H "Content-Type: application/json" \
  -d '{"code": "A3XR7M2", "userId": "homeassistant"}'

import requests

resp = requests.post('http://your-server:8082/api/register', json={
    'code': 'A3XR7M2',
    'userId': 'homeassistant'
})
result = resp.json()

if result['success']:
    print(f"Registered device: {result['serial']}")
else:
    print(f"Registration failed: {result['message']}")

​

Related