> ## Documentation Index
> Fetch the complete documentation index at: https://docs.telemax.com.au/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Overview of the Telemax External API for fleet telemetry, vehicle commands, and integrations.

The **Telemax External API** is a standalone ASP.NET Core REST service that exposes fleet operations to third-party systems and mobile clients. It provides JWT-based access to live and historical vehicle positions, trip replays with map-ready polylines, company-scoped fleet snapshots, alerts, battery health predictions, safety scores, and remote commands (ignition, door lock, odometer, rename, and location workflows).

## Who it's for

* **Integration partners** building billing, dispatch, or analytics on top of Telemax fleet data.
* **Mobile and backend clients** that authenticate with either dashboard user credentials or company API keys.
* **Operators and developers** maintaining automation against the same contracts as the legacy Telemax integration surface.

## Key capabilities

* **Dual login paths**: username/password or API key, both returning a **Bearer JWT** with company, timezone, and (for API keys) optional vehicle and action claims.
* **Telemetry**: last position, historical positions, trip replay (UTC or user-time-oriented callers), IMEI lookup, nearest-vehicle search, and fleet-wide snapshots.
* **Commands**: ignition, door lock (ATrack SMS path), odometer update, vehicle rename, and location update handoff (where IMEI exists).
* **Alerts**: list alerts with reverse geocoding, mark one or all as read for permitted companies.
* **Insights**: paged battery health predictions and trip safety scores over configurable intervals.
* **Diagnostics**: latest DTC codes from vehicle handler state.

<Note>
  **POST-first design:** Almost all Telemax API endpoints use `POST` regardless of whether the operation reads or writes data. Parameters are passed as **query string values**, not a JSON request body. The two exceptions that use `GET` are `GetDeviceId` (IMEI lookup) and `devices/{deviceId}/dtc-codes` (DTC code retrieval). If your HTTP client defaults to `GET` for read operations, you will need to override the method explicitly.
</Note>

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/v1/quickstart">
    Obtain a JWT and call your first authenticated route.
  </Card>

  <Card title="API Reference" icon="code" href="/v1/api-reference/post-authentication-token-user">
    Endpoint guides with interactive Try it for each route—start with authentication.
  </Card>
</CardGroup>

## Guides

<CardGroup cols={2}>
  <Card title="Real-Time Fleet Tracking" icon="map" href="/v1/guides/fleet-tracking">
    Poll fleet positions and render live vehicle locations on a map.
  </Card>

  <Card title="Trip Replay" icon="route" href="/v1/guides/trip-replay">
    Fetch trip waypoints, decode polylines, and render on Google Maps or Leaflet.
  </Card>

  <Card title="Alert Monitoring" icon="bell" href="/v1/guides/alert-monitoring">
    Poll, filter, and acknowledge alerts in a stateful pipeline.
  </Card>

  <Card title="Vehicle Health Dashboard" icon="heart-pulse" href="/v1/guides/vehicle-diagnostics">
    Combine position, battery health, and DTC codes into a single dashboard view.
  </Card>
</CardGroup>