Complete API Documentation

Enterprise-grade construction management and smart home automation platform

Version 1.0.0 • Last Updated: November 2025

📚

48 Endpoints

Complete REST API coverage for all features

🔒

JWT Auth

Secure authentication with refresh tokens

⚡

Real-time

MQTT for instant IoT device updates

✨ Platform Features

🌐

RESTful API

48 endpoints organized by resource type

📡

Real-time MQTT

IoT device communication via EMQX Cloud

🏢

Multi-tenant

Organization-based data isolation

🔐

RBAC

7 user roles with granular permissions

📁

File Storage

Cloudflare R2 for documents and images

⏱️

Rate Limiting

Redis-based request throttling

📋 API Resources

🔐

Authentication

View API endpoints

👤

Users

View API endpoints

🏢

Organizations

View API endpoints

📊

Projects

View API endpoints

✓

Tasks

View API endpoints

📄

Documents

View API endpoints

💬

Messages

View API endpoints

🔔

Notifications

View API endpoints

📱

IoT Devices

View API endpoints

⚡

Automations

View API endpoints

📡

MQTT

View API endpoints

👑

Admin

View API endpoints

🚀 Quick Start

Base URLs

Development:http://localhost:3000

Staging:https://staging.elipse.app

Production:https://elipse.app

Authentication

All authenticated endpoints require a Bearer token:

Authorization: Bearer <access_token>

Access tokens expire after 1 hour. Use refresh token endpoint to get new tokens.

Implementation Phases

Phase 1: Core (Required)

Phase 2: Organizations (High Priority)

Create Org, Projects, Members, Tasks

Phase 3: IoT (Medium Priority)

Device Registration, Commands, Telemetry

Phase 4: Advanced (Low Priority)

Automations, Admin Panel, Analytics

🔐 User Roles

SUPER_ADMIN

Platform administration

ADMIN

Organization management

MANAGER

Project oversight

WORKER

Field execution

CONTRACTOR

External contractors

VENDOR

Material suppliers

CLIENT

Project owners

🛠️ Technical Specifications

Database Schema

• organizations - Multi-tenant companies
• users - User accounts with RBAC
• projects - Construction projects
• tasks - Project tasks
• documents - File uploads
• devices - IoT devices
• automations - Smart rules
• mqtt_credentials - Device auth

Security Features

• JWT Authentication - HS256 with refresh tokens
• bcrypt Hashing - 12 rounds for passwords
• Rate Limiting - Redis-based throttling
• Input Validation - Zod schema validation
• SQL Injection Protection - Parameterized queries
• XSS Prevention - Input sanitization
• CORS - Configurable allowed origins
• HTTPS Only - TLS 1.3 enforced

📡 MQTT Topics

Topic structure for IoT device communication:

elipse/{projectId}/devices/{deviceId}/telemetry

Device sensor data and status updates

elipse/{projectId}/devices/{deviceId}/commands

Control commands sent to devices

elipse/{projectId}/devices/{deviceId}/status

Device online/offline status

🔗 Interactive Documentation

For detailed endpoint information with copy-to-clipboard functionality, environment switching, and live examples:

📚 Interactive API Docs ⚙️ Setup Guide ✓ Health Check

Enterprise-grade IoT & Construction Management Platform