Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.bookovia.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Quickstart Guide

Get up and running with the Bookovia Telematics API in just a few minutes. This guide will walk you through creating your first trip, uploading location data, and retrieving analytics.

​
Prerequisites

Before you begin, you’ll need:
  • A Bookovia account (sign up here)
  • An API key (generated from your dashboard)
  • A development environment with internet access

​
Step 1: Get Your API Key

  1. Sign up at dashboard.bookovia.com
  2. Navigate to the API Keys section
  3. Generate a new API key for your environment:
    • bkv_test_* for development and testing
    • bkv_live_* for production use
Keep your API key secure! Never expose it in client-side code or commit it to version control.

​
Step 2: Make Your First Request

Let’s start by checking your API connection: 
curl -H "X-API-Key: bkv_test_your_api_key_here" \
     https://api.bookovia.com/v1/health
Expected Response: 
{
  "status": "healthy",
  "version": "v1",
  "timestamp": "2024-04-13T10:30:00Z"
}

​
Step 3: Start Your First Trip

Now let’s create a trip to track a vehicle journey: 
curl -X POST https://api.bookovia.com/v1/trips/start \
  -H "X-API-Key: bkv_test_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "vehicle_id": "vehicle_123",
    "driver_id": "driver_456",
    "metadata": {
      "purpose": "delivery",
      "route": "downtown"
    }
  }'
Response: 
{
  "trip_id": "trip_7890abcd",
  "vehicle_id": "vehicle_123",
  "driver_id": "driver_456",
  "status": "active",
  "start_time": "2024-04-13T10:30:00Z",
  "start_location": null,
  "metadata": {
    "purpose": "delivery",
    "route": "downtown"
  }
}
Save the trip_id - you’ll need it for uploading location data and stopping the trip.

​
Step 4: Upload Location Data

Now let’s simulate some GPS coordinates for your trip: 
curl -X POST https://api.bookovia.com/v1/locations/batch-upload \
  -H "X-API-Key: bkv_test_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "trip_id": "trip_7890abcd",
    "locations": [
      {
        "latitude": 40.7128,
        "longitude": -74.0060,
        "timestamp": "2024-04-13T10:30:00Z",
        "speed": 0,
        "heading": 0
      },
      {
        "latitude": 40.7130,
        "longitude": -74.0058,
        "timestamp": "2024-04-13T10:30:30Z",
        "speed": 25,
        "heading": 45
      }
    ]
  }'

​
Step 5: Get Trip Analytics

Let’s retrieve some analytics for your trip: 
curl -H "X-API-Key: bkv_test_your_api_key_here" \
     https://api.bookovia.com/v1/trips/trip_7890abcd
Response: 
{
  "trip_id": "trip_7890abcd",
  "vehicle_id": "vehicle_123",
  "driver_id": "driver_456",
  "status": "active",
  "start_time": "2024-04-13T10:30:00Z",
  "distance_km": 0.2,
  "duration_minutes": 0.5,
  "max_speed_kmh": 25,
  "avg_speed_kmh": 15,
  "locations_count": 2,
  "safety_score": 95,
  "events": []
}

​
Step 6: Stop the Trip

When the journey is complete, stop the trip: 
curl -X POST https://api.bookovia.com/v1/trips/trip_7890abcd/stop \
  -H "X-API-Key: bkv_test_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "end_location": {
      "latitude": 40.7130,
      "longitude": -74.0058
    }
  }'

​
Next Steps

Congratulations! You’ve successfully:
  • ✅ Created your first trip
  • ✅ Uploaded location data
  • ✅ Retrieved trip analytics
  • ✅ Stopped the trip

​
Explore More Features

Real-time Streaming

Learn about WebSocket connections for live data feeds

Safety Analytics

Dive into driver behavior analysis and safety scoring

Fleet Management

Manage multiple vehicles and optimize operations

Client SDKs

Use our production-ready SDKs for faster integration

​
Production Checklist

Before going live, make sure you:
Replace your bkv_test_* key with a bkv_live_* key from your dashboard
Add proper error handling for network issues and API errors
Implement exponential backoff for rate limit handling
Set up monitoring and alerting for your API usage

​
Need Help?

Ready for production? Check out our authentication guide and integration examples.