Skip to main content

SmartLink Installation Guide and API Reference Now Available

· 2 min read

Two new documentation sections are now available: the SmartLink Installation Guide and the updated API Reference for both the ConnectBox API and the Usage Data API.

The SmartLink is a compact smart plug that doubles as a whole-home energy meter. The new SmartLink Installation Guide walks you through the complete setup process, covering:

  • Requirements and prerequisites — everything you need before starting, including device placement guidelines and Wi-Fi requirements.
  • Mobile app setup — step-by-step instructions for signing in, scanning the QR code, connecting to Wi-Fi, and binding to your smart meter.
  • Installation verification — how to confirm your SmartLink is online and reporting real-time energy data.
  • Troubleshooting — solutions for common issues such as connection failures, communication errors, and LED status indicators.

API reference updates​

The API reference now covers two complete API systems:

ConnectBox API​

The ConnectBox API provides integration between utility backend systems and the EnergyGrid Platform. It includes:

  • Customer Synchronization (POST /powerbox/customer) — sync customer account details, service addresses, and meter configurations from your utility CIS.
  • Hardware Binding (POST /powerbox/bind) — link a DataBridge or SmartLink device to an AMI meter over the utility's wireless mesh radio.

Authentication uses OAuth 2.0 Bearer tokens in JWT format.

Usage API​

The Usage API exposes endpoints for accessing energy usage data and insights. Categories include:

  • Customer — login, profile management, budget settings, and home profile configuration.
  • Insights — energy usage breakdowns, main uses of energy, and message carousels.
  • Similar Homes — comparison data against similar households.
  • Usage — filtered energy usage data.
  • Metadata — thing types, categories, granularity types, property types, and metric types.
  • Rate Data — rate groups and billing cycle dates.

Integration Guide​

For a high-level walkthrough of how these APIs work together, see the Integration Guide, which covers the full flow from hosting the ConnectBox middleware through OAuth setup, customer synchronization, bulk data ingestion, and hardware binding.