WhereFy Developer Hub

📦 SDKs Available

• Python SDK: For scripting energy data ingestion and retrieval.
• Node.js SDK: For server-side integration with CRMs and dashboards.
• ESP32/Embedded SDK: Lightweight C/C++ SDK for hardware developers.
• React Web SDK: Pre-built UI widgets to display parameter cards, charts, and alerts.

🔌 Core APIs

• Device Ingestion API: Register and push MQTT or HTTP payloads.
• Data Query API: Fetch time-series data, aggregates, or filter by time/client.
• Alerts API: Define, trigger, and listen to real-time alerts via webhook or email.
• Auth & Tenant API: Secure multi-client access and role-based permissions.
• Client Management API: Add, edit, or remove client organizations and users.
• Parameter Definitions API: Manage metadata and thresholds for each sensor or metric.
• Dashboard Configuration API: Personalize layouts, card views, and widget placements.
• Webhook Integration API: Push event-driven updates to external systems.

🧹 Full API Suite (GCRUD)

GET /devices          // List all devices
POST /devices         // Register a new device
PUT /devices/:id      // Update an existing device
DELETE /devices/:id   // Remove a device
GET /data             // Query historical data
GET /alerts           // Fetch current alerts
POST /clients         // Add new clients
GET /config           // Retrieve dashboard configuration
POST /webhook         // Register webhook URLs
GET /parameters       // List parameter metadata

🛠️ Code Samples

Explore real-world examples and copy-paste ready integrations:

✔ ESP32 MQTT Code to Push Sensor Data

client.publish("/device123/temp", String(tempValue));
delay(15000);

✔ Node.js Script for Fetching Alerts

const axios = require('axios');
axios.get('https://api.wherefy.io/alerts')
  .then(response => console.log(response.data));

✔ Python Script for Analyzing 15-min Interval Data

import pandas as pd
import requests
response = requests.get("https://api.wherefy.io/data")
df = pd.DataFrame(response.json())
df.resample('15T').mean()

✔ React Component to Display a Live Parameter Card

import React from 'react';
export default function ParameterCard({ value }) {
  return 
Live Value: {value}
;
}

✔ Sample Dashboard JSON Layout Configuration

{
  "widgets": [
    { "type": "gauge", "param": "voltage" },
    { "type": "chart", "param": "current" }
  ]
}

✔ Postman Collection to Test All Core APIs

{
  "info": {
    "name": "WhereFy Core APIs"
  },
  "item": [
    { "name": "GET Devices", "request": { "url": "/devices" } }
  ]
}

📈 Performance Dashboards

Get started with our ready-to-use dashboards built with React and Tailwind for real-time monitoring:

• ✔ Energy Monitoring Dashboard for Solar Plants and Factories
• ✔ Multi-Client Dashboard with Role-Based Access Control
• ✔ Real-Time Alerts Panel with Acknowledgment Workflow
• ✔ Parameter Cards, Charts, Gauges, and Daily Trends
• ✔ Configurable Layouts via JSON or API