Getting Started

This guide walks you through the essential steps to integrate your devices with the Flip platform.

1. Create an API Key

Sign in to the Developer Console and create a new OAuth client. This will generate an API key in the format fl_<public_key>_<secret>.

2. Register a Site

Create a site representing the physical location where the device is installed:

curl -X POST https://api.flip.energy/v1/site \
  -H "Authorization: Bearer fl_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "123 Main St", "timezone": "America/New_York"}'

3. Register a Device

curl -X POST https://api.flip.energy/v1/site/{siteId}/devices \
  -H "Authorization: Bearer fl_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"manufacturer": "your-oem", "model": "model-1"}'

4. Report Telemetry

Submit telemetry data for your devices on a regular cadence:

curl -X POST https://api.flip.energy/v1/site/{siteId}/telemetry \
  -H "Authorization: Bearer fl_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"devices": [{"deviceId": "...", "soc": 85, "powerW": 1500}]}'

5. Handle Commands

Poll for or receive commands via webhook, then execute them on the device and report back the result.

Next Steps

Explore the API Reference for complete endpoint documentation including request/response schemas.