1. End-User Enrollment & OAuth Flow
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. End-User Enrollment & OAuth Flow

0. Introduction

This section details the business lifecycle of integrating a user's device into your VPP platform. The process is initiated by the end-user within your application and finalized via the FoxCloud authorization system.
⚠️ Critical Prerequisite: Device Compatibility & Control Handover
Before integration, please note the following:
1.
Device Compatibility: Not all hardware models or firmware versions support VPP features.
Action: Consult the Device Compatibility Matrix in the Reference section.
Impact: Incompatible devices will appear as "Not Supported" during the authorization flow.
2.
Control Transfer (VPP in Control): Upon successful onboarding, the device's scheduling module in the Fox app will display "VPP in Control".
Restriction: The end-user will be prohibited from manually adjusting dispatch schedules or overriding commands via the Fox app until the device is offboarded from any VPP. All control is managed exclusively through our API.
Modified at 2026-08-04 02:41:52
Previous
2. Environments & Prerequisites
Next
1. The User Authorization Journey
Built with