📄️ Homsai Backend v2
This documentation describes the REST APIs of the Homsai Backend v2, a platform for monitoring and optimizing residential and industrial energy systems.
📄️ Domain Model & Data
This section introduces the Homsai domain model and the main entities you will work with: plants, devices, sensors, and related metadata.
📄️ Authentication
This section explains how authentication and authorization work in Homsai Backend v2: JWT tokens, permission model, and common security conventions for the APIs.
📄️ Working with endpoints
This section explains how to use Homsai APIs to model a plant: creating and managing plants, devices and sensors, and the recommended client‑side workflow.
📄️ Pagination, Filtering & Dates
This section explains how to use common pagination, search, filtering and date parameters across Homsai endpoints.
📄️ Energy Metrics & Forecasts
This section explains how to read consumption, production, energy history, forecasts and PV plant health using Homsai APIs.
📄️ Types & Configuration
This section describes Homsai’s cross‑cutting configuration entities: sensor and device types, load signatures, collected data types, and vendors associated with a plant.
📄️ Errors & Troubleshooting
This section describes how Homsai returns API errors, which HTTP codes are commonly used, and how to handle them on the client side.
📄️ API Reference & Swagger
This section explains how to access the full Homsai API reference through Swagger UI and how to use it together with the “wiki” documentation.
📄️ SDKs & Code Examples
This section provides practical examples of how to use the Homsai APIs in different contexts, using cURL and common HTTP clients. The examples reuse the most important endpoints described in the other sections.