Documentation API Carrierweb EAI

Accedez aux donnees de votre flotte Carrierweb via une API REST JSON securisee. Cette application centralise les donnees vehicules, positions, conducteurs, trajets, telemetrie et alarmes pour chaque tenant.

Authentification

Toutes les requetes necessitent une cle API fournie par l administrateur. Transmettez-la via le header HTTP X-API-Key.

Comment obtenir votre cle API ?

Contactez l administrateur du systeme. Chaque tenant dispose d une cle API unique permettant d acceder uniquement aux donnees de son organisation.

Header requis

X-API-Key: votre-cle-api-ici

Vous pouvez aussi utiliser le header Authorization: Bearer votre-cle.

Base URL

https://votre-domaine/api/public/v1

Tous les endpoints ci-dessous sont prefixes par cette base URL.

Vehicules

GET/vehicles

Liste des vehicules du tenant. Filtres possibles : limit, offset, search, vehicleid, since, until.

Parametre	Type	Description
limit	integer	optionnel — Nombre de resultats (defaut: 100, max: 1000)
offset	integer	optionnel — Decalage de pagination
search	string	optionnel — Filtre textuel sur VehicleNumber ou VehicleName
vehicleid	integer	optionnel — Filtrer par CWVehicleID
since	string	optionnel — Date debut (ISO 8601)
until	string	optionnel — Date fin (ISO 8601)

curl -H "X-API-Key: votre-cle" \ "https://votre-domaine/api/public/v1/vehicles?limit=10&offset=0"

GET/vehicles/{id}

Detail d un vehicule par son identifiant (CWVehicleID).

Positions GPS

GET/positions

Dernieres positions connues des vehicules. Filtres : vehicleid, since, until.

curl -H "X-API-Key: votre-cle" \ "https://votre-domaine/api/public/v1/positions?vehicleid=250085&since=2026-02-12&until=2026-02-13"

Conducteurs

GET/drivers

Liste des conducteurs.

GET/drivers/{id}

Detail d un conducteur.

Trajets

GET/trips

Liste des trajets / jobs en cours.

GET/trips/{id}

Detail d un trajet.

Telemetrie

GET/telemetry

Donnees de telemetrie en temps reel : temperature, capteurs, etat du vehicule. Filtres : vehicleid, since, until.

curl -H "X-API-Key: votre-cle" \ "https://votre-domaine/api/public/v1/telemetry?vehicleid=250085&since=2026-02-12&until=2026-02-13"

CAN Bus

GET/canbus

Donnees CAN Bus historiques par vehicule. Filtres : vehicleid, since, until.

curl -H "X-API-Key: votre-cle" \ "https://votre-domaine/api/public/v1/canbus?vehicleid=250085&since=2026-02-12&until=2026-02-13"

Alarmes

GET/alarms

Liste des alarmes actives.

GET/alarms/{id}

Detail d une alarme.

Activites vehicules

GET/activities

Activites recentes des vehicules : mouvements, changements d etat.

Points de repere

GET/landmarks

Points de repere (landmarks) configures dans le systeme Carrierweb. Filtres : vehicleid, since, until.

curl -H "X-API-Key: votre-cle" \ "https://votre-domaine/api/public/v1/landmarks?vehicleid=0&since=2025-11-15&until=2025-11-16"

GET/landmarkgroups

Groupes de points de repere.

Pagination

Tous les endpoints de liste supportent la pagination via limit et offset, et le filtrage par date via since / until (ou after / before). Le filtre par vehicule vehicleid est disponible sur les ressources positions, canbus, telemetry et landmarks.

Parametre	Valeur par defaut	Maximum
limit	100	1000
offset	0	—
since / after	—	ISO 8601
until / before	—	ISO 8601
vehicleid	—	CWVehicleID (integer)

La reponse inclut un objet pagination avec hasMore pour faciliter la navigation.

Codes d erreur

Code HTTP	Code API	Description
400	BAD_REQUEST	Parametres invalides ou manquants
401	UNAUTHORIZED	Cle API invalide ou manquante
403	FORBIDDEN	Tenant desactive ou suspendu
404	NOT_FOUND	Ressource introuvable
429	RATE_LIMITED	Trop de requetes
500	SERVER_ERROR	Erreur serveur interne