Flip Energy API
Flip Energy API
  • Overview
  • Important concepts
  • Authentication
  • Enrollment process
  • End-user app design
  • Monitoring / Telemetry
  • Control
  • Mobile App API
    • Devices
      • Create Device
      • Read Devices
      • Read Device
      • Update Device
      • Delete Device
    • Enrollments
      • Create Enrollment
      • Read Enrollments
      • Read Enrollment
      • Delete Enrollment
    • Events
      • Read Events
      • Read Event
      • Update Event Participation
    • Programs
      • Read Programs
      • Read Program
    • Sites
      • Read Site
      • Update Site
  • Cloud API
    • Sites
      • Get Site Token
      • Get Sites
    • Commissioning
      • Commission Site And Devices
    • Telemetry
      • Report Battery Telemetry
    • Commands
      • Command Created
      • Read Commands
      • Update Command Status
    • Webhooks
      • Overview
      • List of events
      • Webhook headers
      • Schemas
        • Command
        • Enrollment
        • Event

Overview

Welcome to Flip's API documentation.
The API is split in two sections:

Mobile App API#

It is meant to be used as the backend for the VPP tab of your mobile app, and is only used to provide end-users with information about their participation in VPPs.

Cloud API#

It is meant to connect directly to your cloud, which itself connects to devices. It includes endpoints for:
monitoring (Telemetry)
control (Commands)
fetching authentication tokens to use in the mobile app (Site authentication)
commissioning devices in our system (Commissioning)
receiving machine-to-machine updates (Webhooks)
Modified at 2024-06-28 12:37:49
Next
Important concepts
Built with