API Documentation

OBDebug Sync API for Android app integration

Authentication Required: All API endpoints require valid API key and Device ID headers. API keys are embedded in the official Android app only.

GET /api/sync.php

Description: Pull vehicle database and protocol library from server

Query Parameters:

type - Data type to pull: 'all', 'vehicles', 'protocols' (default: 'all')
last_sync - Last sync timestamp (optional)

Response:

{
  "makes": [...],
  "models": [...],
  "engines": [...],
  "protocols": [...],
  "sync_timestamp": "2025-01-20 12:00:00"
}

POST /api/sync.php

Description: Push custom vehicles and scan data to server

Request Body:

{
  "type": "custom_vehicles" | "scan_data",
  "device_id": "unique_device_id",
  "data": {
    "makes": [...],
    "models": [...],
    "engines": [...],
    "session": {...},
    "responses": [...]
  }
}

Response:

{
  "success": true,
  "items_synced": 25,
  "message": "Data synced successfully"
}

GET /api/download.php

Description: Download latest APK file

Tracks download statistics and serves APK file

Base URL:

https://obdebug.com/api/

Authentication:

Currently no authentication required. API keys will be required in production.