1. Getting Started
FoxCloud OpenAPI
Vpp Flow
  • Vpp Flow
  • Full API Reference
  • What's New & Milestones
  • Getting Started
    • 1. Overview & Integration Scope
    • 2. Environments & Prerequisites
  • End-User Enrollment & OAuth Flow
    • 0. Introduction
    • 1. The User Authorization Journey
    • 2. OAuth Token Operating Model
    • 3. Implementation Guide
  • API Technical Specifications
    • 1. Universal Request Rules
    • 2. Rate Limiting Strategy
    • 3. Response Structure
    • 4. Error Code Reference
  • Telemetry & Data Acquisition
    • 1. Data Pipeline & Scaling Strategy
    • 2. Telemetry Data Query (Real-time)
    • 4. Telemetry Variable Dictionary
    • 5. System Performance & SLA
    • 3. Device Configuration & Settings: Pre-Dispatch State Awareness
  • Control Commands & Dispatch
    • 1. Core Dispatch Architecture: Scheduler V3
    • 2. Scheduler V3 Operations
    • 3. Real-time Device Settings
    • 4. Strategic Roadmap: Scaling for Massive Fleets
  • FAQ
    • Troubleshooting Quick Guide
  1. Getting Started

1. Overview & Integration Scope

1.1 Target Audience & Purpose#

This documentation is exclusively designed for third-party Virtual Power Plant (VPP) operators and platform developers.
Goal: Enable your platform to securely enroll end-users, collect telemetry data, and dispatch control commands to FoxESS battery devices.
Boundary: Your platform never communicates directly with hardware. FoxCloud acts as the mandatory intermediary for all data and commands.

1.2 Integration Architecture#

The integration follows a strict OAuth 2.0 flow for enrollment and a Brokered Data model for operations.
Data Flow Explained:
1.
Enrollment (OAuth): The end-user grants permission via the FoxESS h5 page.
2.
Telemetry (Pull/Push): Data flows from Device → FoxCloud → Your Platform (via API Polling or Kafka).
3.
Control (API): Commands flow from Your Platform → FoxCloud → Device.

1.3 Documentation Roadmap#

This guide is structured as a linear journey. Follow these steps to go live:
1.
Phase 1: User Enrollment (End-User Enrollment & OAuth Flow)
Focus: How to get user permission and bind devices.
Key Flow: Redirect -> Consent -> Device SN callback.
2.
Phase 2: API Technical Foundation (API Technical Specifications)
Focus: The universal rules for calling all FoxCloud APIs (Authentication, Signing, Error Handling).
Key Concept: signature header, timestamp, and response codes.
3.
Phase 3: Data & Control (Telemetry & Command Modules)
Focus: Specific payloads for fetching data and sending commands.
Modified at 2026-08-04 02:41:31
Previous
What's New & Milestones
Next
2. Environments & Prerequisites
Built with