Use Cases/Guides
Digital Twin Sync
The SitePro API enables synchronization between SitePro and external systems such as CMMS or asset management platforms. By pulling site configuration, sensor mappings, and asset hierarchies into your system, you can maintain a consistent digital representation of your sites across platforms.
This guide outlines how to keep your external system aligned with SitePro to prevent configuration drift and ensure operational accuracy.
Endpoints: /v1/config/site
Request - Load Site Config
curl https://platform.sitepro.com/v1/config/site?siteId=36442 \
-H "Authorization: Bearer <JWT_token>"
Response
Returns a single object with five arrays. Each array contains fully detailed objects for that equipment type, including hardware register mappings.
| Array | Contains |
|---|---|
| devices | Hardware I/O devices and their Modbus register definitions |
| sensors | All sensors on the site - units, conversion settings, min/max ranges, and register references. Typically the largest array (50–150+ items). |
| meters | Flow meters linked to their sensors and flow register mappings |
| pumps | Pumps with linked sensors (head pressure, suction, vibration) and VFD register mappings |
| tankGroups | Tank groups with capacity, height limits, oil/water layer settings, and linked sensor IDs |
Lighter alternatives
| Endpoint | Use when... |
|---|---|
| GET /v1/config/site/light | You need equipment config but not full register-level detail |
| GET /v1/config/site/compact | You only need basic equipment identity and linkage |
| GET /v1/config/updates/site | You want only what has changed since a given date (requires startDate query param) |
Note: Objects across the five arrays link to each other via ID fields - for example, a pump references its sensors by SiteSensorID and its meter by SiteFlowMeterID. Use these to build your equipment relationships after loading the config.
How It Works
- Retrieve Site Configuration
Pull site-level data, including devices, sensors, and structure - Sync Sensor Mappings
Map SitePro sensors to assets in your external system - Align Asset Hierarchy
Mirror SitePro’s structure (site → equipment → sensors) - Schedule Ongoing Sync
Periodically refresh data to capture updates and changes
What Data to Sync
Site Configuration
- Site IDs and names
- Device and edge configurations
- Available sensors and data points
Sensor Mappings
- Sensor identifiers
- Sensor types (pressure, temperature, etc.)
- Units and measurement context
Asset Hierarchy
- Site → system → equipment relationships
- Mapping sensors to physical assets
- Organizational structure used for reporting and monitoring
How Integrators Use This
CMMS Integration
- Automatically associate sensors with equipment records
- Trigger maintenance workflows based on sensor data
- Ensure asset records reflect real-world configurations
Asset Management Systems
- Maintain a live digital twin of SitePro-managed sites
- Keep asset structures aligned across platforms
- Reduce manual configuration updates
Operational Consistency
- Ensure dashboards and reports reflect accurate site structures
- Avoid mismatches between SitePro and external tools
- Support cross-system analytics and workflows