Skip to content
TLGPSDocumentation

Developer documentation

Developer documentation

Getting started

Prepare authorized access and make a first read.

Make a first authorized read before adding a long-lived Gateway connection.

1. Confirm access

Arrange an active TLGPS Company account through your authorized Company contact. Confirm the required REST API or Gateway capability is available to the Company and that your account has the appropriate effective permissions. Access provisioning is controlled; this documentation does not create access.

2. Prepare a credential

If your account is authorized to issue Personal Access Tokens, use the Portal API Tokens page to create a token with the required abilities and an appropriate expiry. Otherwise contact an authorized administrator. Tokens cannot grant permissions or Company capabilities the owner does not have.

Keep tokens on a trusted server. Do not embed a Personal Access Token in a public browser bundle, URL, repository or screenshot. Record the issued secret securely; use an obvious placeholder in shared examples.

3. Read visible vehicles

Use the public API base URL supplied for your environment:

GET https://api.tlgps.athear.ly/v1/vehicles
Authorization: Bearer <token>
Accept: application/json

This request requires the vehicles.view-any token ability and the matching effective permission. The response includes only visible vehicles. An empty collection can be a valid result; authentication does not imply access to every vehicle.

4. Use a returned identifier

Use a vehicle UUID from an authorized response for vehicle detail or history. Each operation has its own ability and permission requirements. History also requires from and to query parameters.

5. Continue with Gateway

For supported vehicle updates, review Gateway connection, then vehicle subscriptions. Wait for successful authentication before subscribing. Initial state is sent only when available. Plan for disconnects and recreate subscriptions on a new authenticated connection.

Public documentation · authorized integration access required

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

Back to top