API Overview

BCGMCU Device-Side API Overview

The BCGMCU device-side API provides comprehensive endpoints for ESP32C6 devices to communicate with cloud services for biomonitoring data collection and device management.

Base Configuration

All API endpoints use the following base configuration:

• Base URL: https://your-endpoint.com/api/v1
• Protocol: HTTPS with TLS 1.2+
• Format: JSON
• Authentication: Bearer token (JWT)
• Content-Type: application/json

Available Endpoints

Device Management

• Registration - Initial device onboarding
• Status Updates - Health checks and connectivity
• Configuration - Remote settings management

Data Transmission

• Stream Data - Real-time 1Hz data transmission
• Batch Upload - High-volume data transfer

Device Control

• Commands - Remote operations (reset, calibration)
• Calibration - Calibration procedures

Request Headers

All requests must include:

Authorization: Bearer {device_token}
Content-Type: application/json

Response Format

All responses follow this structure:

{
  "status": "success|error",
  "server_timestamp": "2025-01-27T10:30:01.000Z",
  "data": { /* endpoint specific */ }
}

Performance Requirements

• Response Time: <200ms for status/config requests
• Throughput: 100 devices × 1Hz = 100 requests/second minimum
• Availability: 99.9% uptime SLA
• Concurrent Devices: 100+ supported

Security Features

• TLS 1.2+ encryption for all communications
• JWT tokens with 24-hour expiration
• SHA-256 checksums for batch data validation
• Request IDs for idempotent operations
• Rate limiting: 1000 requests per device per hour