Skip to content
TLGPSDocumentation

Developer documentation

Developer documentation

Authentication

Credentials, abilities and access prerequisites.

REST API V1 and integration Gateway clients use Personal Access Tokens owned by an authorized TLGPS user. Possessing a token is only one part of access evaluation.

REST credentials

Send the token in the HTTP authorization header on each protected request:

Authorization: Bearer <token>
Accept: application/json

The public API health route does not require a credential. Fleet-resource routes require valid authentication, an active Company with REST API access, the owner's effective permission and the corresponding token ability.

Token abilities

Operation Required ability
GET /v1/companies companies.view-any
GET /v1/companies/{company} companies.view
GET /v1/vehicles vehicles.view-any
GET /v1/vehicles/{vehicle} vehicles.view
GET /v1/vehicles/{vehicle}/history vehicles.history
Gateway vehicle subscription telemetry.subscribe

Abilities restrict a credential. They never grant the token owner additional application permissions or resource visibility.

Gateway credentials

Integration clients send an authenticate message after opening the configured WebSocket endpoint:

{
    "type": "authenticate",
    "data": { "token": "<token>" }
}

Wait for authenticated before sending subscriptions. The token owner needs Gateway access, effective telemetry.subscribe, vehicle access and the matching token ability. The first-party Portal uses a separate browser credential; it is not a public token-provisioning API.

Credential handling

Use HTTPS and WSS for deployed integrations. Never publish secrets in examples, URLs or client-side applications. Expired or revoked credentials cannot establish authorized access. Existing Gateway connections remain subject to periodic authorization checks and can be closed when access changes.

Public documentation · authorized integration access required

Engineering-maintained documentation. Examples use synthetic data and placeholder credentials.

Back to top