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

2. Environments & Prerequisites

2.1 Environment Isolation#

⚠️ The Foundation
Before you write any code, it is important to understand our environment architecture. Sandbox is designed for testing integration logic; Production is for live operations.
EnvironmentStatusBase URL (API Endpoint)Data SourceCredential Scope
ProductionAvailablehttps://www.foxesscloud.comLive end-user devicesProduction App Registration
SandboxComing SoonComing SoonReal devices (non-production)Sandbox App Registration
🚨 Critical Warning for Current Integrations
Since the Sandbox environment is currently under development, all integration testing must be performed in the Production environment using non-critical test devices.
Do not mix credentials: You must register separate applications in the Developer Portal for Sandbox and Production once the Sandbox is officially released.

2.2 Credential Management#

To access FoxCloud APIs, you must register a Client App in the Developer Portal.
Steps to Get Credentials:
1.
Register: Create an account at the FoxCloud Developer Portal.
2.
Apply: Submit a Client App application.
Purpose: Select VPP.
Mode: Select OAuth Code Mode.
3.
Secure: Upon approval, you will receive a client_id and client_secret.
💡 Security Best Practice
The client_secret is shown only once upon creation. Copy and store it securely in your backend environment variables immediately. If lost, you must regenerate it.
Modified at 2026-08-04 02:41:45
Previous
1. Overview & Integration Scope
Next
0. Introduction
Built with