Endpoints

L'API donne accès aux données dynamiques (position, statut, données CAN, batterie, trajets) des véhicules équipés de boîtiers télématiques.

Structures de données

Objet vehicle

Informations standard sur le véhicule.

Nom du champ	Type	Description
id	String	Identifiant interne du véhicule.
plate	String	Immatriculation.
vin	String	N° d'identification du véhicule / VIN.
brand	String	Marque du véhicule.
model	String	Dénomination commerciale.

Objet location

Position du véhicule.

Nom du champ	Type	Description
latitude	Number	Latitude.
longitude	Number	Longitude.
angle	Number	Angle. 0° correspond au nord.
altitude	Number	Altitude (en mètres).

Objet can

Donnée CAN configurée et remontée par le boîtier télématique. Les champs peuvent être vides (String) ou à 0 (Number) en cas de manque d'information.

Nom du champ	Type	Description
key	String	Identifiant de la donnée.
value	String	Valeur de la donnée.

Objet status

Données complémentaires sur le statut temps réel du véhicule connecté : usage (statut du moteur) et déplacement. Les champs peuvent être vides (String) ou à 0 (Number) en cas de manque d'information.

Nom du champ	Type	Description
ignition	Bool	État du moteur : true moteur allumé, false moteur éteint.
movement	Bool	État du véhicule : true en mouvement, false à l'arrêt.
mileage	Number	Kilométrage du véhicule.
autonomy	Number	Autonomie du véhicule (en km).

Objet electric

Données concernant la batterie de traction des véhicules électriques.

Nom du champ	Type	Description
soh	Number	État de santé de la batterie (%).
soc	Number	Niveau de charge de la batterie (%).
current	Number	Courant fourni par la batterie (A).
voltage	Number	Voltage de la batterie (V).
energy	Number	Énergie fournie par la batterie (kWh).
maxEnergy	Number	Énergie maximale fournie par la batterie (kWh).
minCellVoltage	Number	Voltage minimum d'une cellule (V).
maxCellVoltage	Number	Voltage maximum d'une cellule (V).
temperature	Number	Température de la batterie (°C).
minCellTemperature	Number	Température minimum d'une cellule (°C).
maxCellTemperature	Number	Température maximale d'une cellule (°C).
lifetimePowerUse	Number	Énergie consommée pendant la durée de vie du véhicule (kWh).
lifetimeChargePower	Number	Énergie chargée pendant la durée de vie du véhicule (kWh).

Élément de sensors

Chaque capteur externe (connecté en Bluetooth au boîtier) apparaît comme un élément du tableau sensors.

Nom du champ	Type	Description
name	String	Nom du capteur.
data	Array	Liste des données remontées par le capteur, au même format que l'objet can. Données actuellement disponibles : température (key = temperature) et taux d'humidité (key = humidity).

Objet state

État du véhicule.

Nom du champ	Type	Description
towing	Boolean	Le véhicule est dans l'état « remorquage ».
accident	Boolean	Le véhicule est accidenté.
maintenance	Boolean	Le véhicule est en révision.
breakdown	Boolean	Le véhicule est en panne.
stolen	Boolean	Le véhicule est déclaré volé.
unavailable	Boolean	Le véhicule est indisponible.

Cet objet n'est présent que dans les réponses concernant l'état courant d'un ou plusieurs véhicules (Données d'usage — tous les véhicules et véhicule spécifique), pas dans l'historique (/history).

Objet trip

Trajet effectué par un véhicule.

Nom du champ	Type	Description
trip_id	String	Identifiant du trajet.
timestamp	Timestamp	Date de début du trajet.
distance	Numeric	Distance parcourue pendant le trajet.
duration	Numeric	Durée du trajet, en minutes.
cost	Numeric	Coût estimé du trajet.
fuel_consumption	Numeric	Carburant consommé, en litres, pour les véhicules thermiques.
fuel_consumption_100km	Numeric	Consommation aux 100 km, pour les véhicules thermiques.
average_speed	Numeric	Vitesse moyenne.
electric_consumption	Numeric	Consommation électrique, pour les véhicules électriques.
electric_consumption_100km	Numeric	Consommation électrique aux 100 km, pour les véhicules électriques.
first_position	Object	Position de début de trajet (latitude, longitude).
last_position	Object	Position de fin de trajet (latitude, longitude).

Champ error

Présent uniquement en cas d'échec (voir Erreurs) — absent des réponses en cas de requête réussie.

Liste des véhicules

Récupère la liste des véhicules associés au compte.

GET /v1/vehicles
x-carmoove-token: <token>

Réponse

Un tableau JSON, un élément par véhicule :

Champ	Type	Description
vehicle	Object	Données concernant le véhicule (objet vehicle).
timestamp	Number	Timestamp de la donnée.
location	Object	Dernière position du véhicule (objet location).
status	Object	Dernier statut du véhicule remonté par le boîtier (objet status).
error	String	Code d'erreur. Absent en cas de requête réussie.

Un véhicule sans donnée disponible est simplement omis du tableau (pas d'élément d'erreur dédié).

Données CAN

Réservées aux véhicules utilisant un protocole CAN propriétaire.

Dernières données CAN de tous les véhicules

GET /v1/vehicles/customcan
x-carmoove-token: <token>

Récupère les informations contenues dans la dernière remontée de données pour tous les véhicules du compte.

Réponse

Un tableau JSON, un élément par véhicule :

Champ	Type	Description
vehicle	Object	Données concernant le véhicule.
timestamp	Number	Timestamp de la donnée.
location	Object	Dernière géolocalisation du véhicule.
can	Array	Liste des données CAN remontées par le boîtier (objets can).
status	Object	Statut du véhicule.
sensors	Array	Liste des capteurs externes et leurs données.
error	String	Code d'erreur. Absent en cas de requête réussie.

Données CAN de tous les véhicules sur une période

GET /v1/vehicles/customcan/from/{timestamp}
x-carmoove-token: <token>

Récupère les informations remontées par tous les véhicules du compte à partir d'une certaine date. Le nombre de données remontées est limité à 10 000 résultats ; les données étant triées par timestamp, une seconde requête peut être faite en utilisant le dernier timestamp de la requête précédente pour récupérer les résultats suivants.

Paramètres

Champ	Type	Description
timestamp	Number	Timestamp UNIX. Renvoie toutes les données remontées par le boîtier depuis cette date.

Réponse

Un tableau JSON, un élément par relevé (potentiellement plusieurs par véhicule sur la période) :

Champ	Type	Description
vehicle	Object	Données concernant le véhicule.
timestamp	Number	Timestamp de la donnée.
location	Object	Position du véhicule.
can	Array	Liste des données CAN remontées par le boîtier.
sensors	Array	Liste des capteurs externes et leurs données.
status	Object	Statut du véhicule.
error	String	Code d'erreur. Absent en cas de requête réussie.

Dernières données CAN d'un véhicule spécifique

GET /v1/vehicle/{id}/customcan
x-carmoove-token: <token>

Récupère les informations contenues dans la dernière remontée de données pour un véhicule spécifique.

Paramètres

Champ	Type	Description
id	String	Identifiant du véhicule.

Réponse

Un objet JSON unique :

Champ	Type	Description
vehicle	Object	Données concernant le véhicule.
timestamp	Number	Timestamp de la donnée.
location	Object	Position du véhicule.
can	Array	Liste des données CAN remontées par le boîtier.
sensors	Array	Liste des capteurs externes et leurs données.
status	Object	Statut du véhicule.
error	String	Code d'erreur. Absent en cas de requête réussie.

Données CAN d'un véhicule spécifique sur une période

GET /v1/vehicle/{id}/customcan/from/{timestamp}
x-carmoove-token: <token>

Récupère les informations remontées par un véhicule spécifique à partir d'une certaine date. Mêmes limites de pagination (10 000 résultats, tri par timestamp) que ci-dessus.

Paramètres

Champ	Type	Description
id	String	Identifiant du véhicule.
timestamp	Number	Timestamp UNIX. Renvoie toutes les données remontées par le boîtier depuis cette date.

Réponse

Un tableau JSON, un élément par relevé sur la période :

Champ	Type	Description
vehicle	Object	Données concernant le véhicule.
timestamp	Number	Timestamp de la donnée.
location	Object	Position du véhicule.
can	Array	Liste des données CAN remontées par le boîtier.
sensors	Array	Liste des capteurs externes et leurs données.
status	Object	Statut du véhicule.
error	String	Code d'erreur. Absent en cas de requête réussie.

Données d'usage

Données d'usage de tous les véhicules

GET /v1/vehicles/status
x-carmoove-token: <token>

Récupère les données contenues dans la dernière remontée de données pour tous les véhicules.

Réponse

Un tableau JSON, un élément par véhicule :

Champ	Type	Description
vehicle	Object	Données concernant le véhicule.
timestamp	Number	Timestamp de la donnée.
location	Object	Position du véhicule.
status	Object	Statut du véhicule.
electric	Object	Batterie du véhicule (véhicule électrique).
sensors	Array	Liste des capteurs externes et leurs données.
state	Object	États du véhicule (remorquage, maintenance, accident, …).
error	String	Code d'erreur. Absent en cas de requête réussie.

Données d'usage de tous les véhicules sur une période

GET /v1/vehicles/history
x-carmoove-token: <token>

Récupère les informations remontées par tous les véhicules du compte pour une période donnée. Le nombre de données remontées est limité à 10 000 résultats (par défaut 3000 ; voir limit), triées par timestamp — utiliser le champ offset pour paginer.

Paramètres

Champ	Type	Description
from	Number	Timestamp UNIX de début de la période.
until	Number	Timestamp UNIX de fin de la période.
limit	Number	Nombre de données à remonter. Optionnel (3000 par défaut).
offset	Number	Nombre de données à ignorer. Optionnel.

Réponse

Un objet JSON, contenant le tableau des relevés dans status (pas d'objet state dans chaque relevé — seuls les endpoints de statut courant l'incluent) :

Champ	Type	Description
status	Array	Liste des relevés, chacun avec les champs vehicle, timestamp, location, status, electric, sensors.
error	String	Code d'erreur. Absent en cas de requête réussie.

Données d'usage d'un véhicule spécifique

GET /v1/vehicle/{id}/status
x-carmoove-token: <token>

Récupère les données contenues dans la dernière remontée de données pour un véhicule spécifique.

Paramètres

Champ	Type	Description
id	String	Identifiant du véhicule.

Réponse

Un objet JSON unique :

Champ	Type	Description
vehicle	Object	Données concernant le véhicule.
timestamp	Number	Timestamp de la donnée.
location	Object	Position du véhicule.
status	Object	Statut du véhicule.
electric	Object	Batterie du véhicule (véhicule électrique).
sensors	Array	Liste des capteurs externes et leurs données.
state	Object	États du véhicule (remorquage, maintenance, accident, …).
error	String	Code d'erreur. Absent en cas de requête réussie.

Données d'usage d'un véhicule spécifique sur une période

GET /v1/vehicle/{id}/history
x-carmoove-token: <token>

Récupère les informations remontées par un véhicule du compte pour une période donnée. Mêmes règles de pagination (limit, offset) que pour l'historique de tous les véhicules.

Paramètres

Champ	Type	Description
id	String	Identifiant du véhicule.
from	Number	Timestamp UNIX de début de la période.
until	Number	Timestamp UNIX de fin de la période.
limit	Number	Nombre de données à remonter. Optionnel (3000 par défaut).
offset	Number	Nombre de données à ignorer. Optionnel.

Réponse

Même forme que l'historique de tous les véhicules — objet contenant le tableau status (sans objet state) :

Champ	Type	Description
status	Array	Liste des relevés, chacun avec les champs vehicle, timestamp, location, status, electric, sensors.
error	String	Code d'erreur. Absent en cas de requête réussie.

Trajets d'un véhicule spécifique

GET /v1/vehicle/{id}/trips?from={from}&until={until}&offset={offset}&limit={limit}
x-carmoove-token: <token>

Récupère la liste des trajets d'un véhicule spécifique.

Paramètres

Champ	Type	Description
id	String	Identifiant du véhicule.
from	Timestamp	Date de début. Optionnel. Par défaut, le début du mois en cours.
until	Timestamp	Date de fin. Optionnel. Par défaut, la date de la requête.
limit	Numeric	Nombre de trajets à renvoyer. Optionnel.
offset	Numeric	Nombre de trajets à ignorer. Optionnel.

Réponse

Champ	Type	Description
trips	Object	Liste des trajets (objets trip).
error	String	Code d'erreur. Absent en cas de requête réussie.

Codes d'erreur spécifiques à cet endpoint : voir Erreurs.