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.
Source des donnees
Les donnees exposees proviennent du systeme Carrierweb EAI (Enterprise Application Integration). Notre plateforme synchronise les tables cwReturn* du backend Carrierweb vers une base centralisee, puis les expose via cette API REST en isolant chaque tenant par EAICustomerID.
| Endpoint API | Table EAI source | Cle primaire |
|---|---|---|
| /vehicles | cwReturnVehicles | CWVehicleID |
| /positions | cwReturnVehiclePositions | ID |
| /drivers | cwReturnDrivers | UpdateID |
| /trips | cwReturnTrips | UpdateID |
| /alarms | cwReturnAlarms | ID |
| /activities | cwReturnActivities | ExportID |
| /telemetry | cwReturnTelemetry | ID |
| /canbus | cwReturnTruckCanbusHistory | ID |
| /landmarks | cwReturnLandmarks | UpdateID |
| /landmarkgroups | cwReturnLandmarkGroups | UpdateID |
Conventions Carrierweb
- Coordonnees GPS :
Latitude/Longitudesont exprimees en degres decimaux multiplies par 100000 (ex. 53.49°N → 5349000, 10.02°W → -1002000). - Distances :
GPSOdometeren km×10 (123 = 12.3km),Speeden km/h. - Volumes :
Fuel,IdleFuel,PTOFuelen 0.1L (125 = 12.5L),FuelLevelen 0.1% (123 = 12.3%). - CO2 en grammes.
- Heures : tous les
*Timesont en GMT (UTC). Le champ correspondant*TimeZonedonne le decalage local en minutes. - VehicleType : 1 = camion (truck), 2 = remorque (trailer).
- Cap :
Heading/CurrentDirectionen degres (0=Nord, 90=Est, 180=Sud, 270=Ouest).
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://api.carrierweb.ma/api/public/v1
Tous les endpoints ci-dessous sont prefixes par cette base URL.
Format de reponse
Toutes les reponses suivent la meme structure JSON. En cas de succes :
{
"success": true,
"data": {
"vehicles": [...],
"tenant": "mon-tenant",
"pagination": {
"total": 145,
"count": 20,
"limit": 20,
"offset": 0,
"hasMore": true
}
}
}
En cas d'erreur :
{
"success": false,
"message": "Invalid or missing API key"
}
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://api.carrierweb.ma/api/public/v1/vehicles?limit=10&offset=0"
Champs retournes (cwReturnVehicles)
| Champ | Type | Description |
|---|---|---|
| CWVehicleID | int | Identifiant unique Carrierweb du vehicule |
| VehicleNumber | char(10) | InHouseId, identifiant client choisi par le tenant |
| VehicleType | tinyint | 1 = camion, 2 = remorque |
| VehicleDescription | char(56) | Description libre du vehicule |
| License | char(15) | Plaque d'immatriculation |
| Owner | char(10) | Proprietaire |
| LastLocation | char(56) | Derniere position connue (texte) |
| LastLocationTime | datetime | Heure GMT de la derniere position |
| LastLocationTimeZone | int | Fuseau horaire local (minutes) |
| Latitude / Longitude | int | Degres decimaux × 100000 |
| GPSOdometer | int | Odometre GPS en km×10 |
| TachoOdometer | int | Odometre tachygraphe |
| ZipCode | varchar(8) | Code postal de la position |
| Speed | int | Vitesse en km/h |
| Heading | int | Cap en degres (0=N, 90=E, 180=S, 270=O) |
| ProximityDistance | int | Distance vers Location la plus proche |
| ProximityDirection | int | Direction de Location vers vehicule (compas) |
| Country | varchar(4) | Code ISO pays / etat |
| CWDriver0ID / Driver0Name / Driver0Number | int / char | Conducteur principal |
| CWDriver1ID / Driver1Name / Driver1Number | int / char | Co-conducteur (le cas echeant) |
| LastReportTime / LastReportTimeZone | datetime | Dernier rapport recu (GMT + tz) |
| HOSActivityId / HOSActivityTime / HOSActivityTimeZone | int / datetime | Activite HOS courante |
| LandmarkID | int | Point de repere actuel |
| BenchmarkID | int | Groupe de benchmark (cwReturnBenchmarks) |
| DivisionID | int | Division |
| SubcontractorCode | char(10) | Code sous-traitant |
| CWTrailerID / TrailerDescription | int / char(15) | Remorque attelee (si trailer matching) |
| MDTConfigurationVersion | varchar(56) | Version de configuration MDT |
| LastCanbusTime / LastCanbusTimeZone | datetime / int | Derniere mesure CAN |
| FuelLevel | int | Niveau actuel du reservoir (0.1%) |
| FuelLevelTime / FuelLevelTimeZone | datetime / int | Heure du dernier releve niveau carburant |
| Fuel | int | Carburant consomme (0.1L) |
| FuelCapacity | int | Capacite du reservoir (capacite × 10) |
| FuelCapacityMeasure | tinyint | 0 = Litre, 1 = Gallon US, 2 = Gallon UK |
| Ignition | int | 0 = contact coupe, 1 = contact mis |
| LandmarkDesc | char(255) | Description du point de repere actuel |
| VIN | varchar(30) | Numero VIN du vehicule (si connu) |
| Hidden | int(3) | 0 = visible, 1 = vehicule masque sur le site web |
GET/vehicles/{id}
Detail d'un vehicule par son identifiant (CWVehicleID).
GET/vehiclesBase
Version allegee de la liste vehicules (meme source de donnees, meme filtres). Utile pour recuperer rapidement les informations de base sans les champs etendus.
curl -H "X-API-Key: votre-cle" \
"https://api.carrierweb.ma/api/public/v1/vehiclesBase?limit=50"
Positions GPS
GET/positions
Historique des positions GPS des vehicules. La colonne de date utilisee est MeasuredTime.
| Parametre | Type | Description |
|---|---|---|
| limit | integer | optionnel — Nombre de resultats (defaut: 100, max: 1000) |
| offset | integer | optionnel — Decalage de pagination |
| vehicleid | integer | optionnel — Filtrer par CWVehicleID |
| since | string | optionnel — Date debut (ISO 8601 ou YYYY-MM-DD) |
| until | string | optionnel — Date fin (ISO 8601 ou YYYY-MM-DD) |
curl -H "X-API-Key: votre-cle" \
"https://api.carrierweb.ma/api/public/v1/positions?vehicleid=250085&since=2026-02-12&until=2026-02-13"
Champs retournes (cwReturnVehiclePositions)
| Champ | Type | Description |
|---|---|---|
| ID | bigint | Identifiant unique de la position |
| CWVehicleID / VehicleNumber / VehicleType | int / char | Reference vehicule |
| MeasuredTime / MeasuredTimeZone | datetime / int | Heure GMT mesuree + fuseau local |
| ReceivedTime / ReceivedTimeZone | datetime / int | Heure GMT de reception serveur |
| GpsValid | int | 1 = position valide, 0 = invalide |
| Latitude / Longitude | int | Degres decimaux × 100000 |
| Country | varchar(4) | Code ISO pays / etat |
| Location | varchar(30) | Ville la plus proche |
| Zipcode | varchar(8) | Code postal le plus proche |
| ProximityDistance / ProximityDirection | int | Distance et direction vers Location |
| LargeCityName / LargeCityDistance / LargeCityDirection | varchar / int | Grande ville la plus proche |
| Ignition | int | 0 = contact coupe, 1 = contact mis |
| CurrentSpeed | int | Vitesse instantanee (km/h) |
| CurrentDirection | int | Cap en degres |
| GPSOdometer | int | Odometre GPS en km×10 |
| PositionType | int(3) | Type de position (voir Annexe I Carrierweb) |
| LandmarkID | bigint | Point de repere si dans une zone (cwReturnLandmarks.ID) |
| RoadName | varchar(60) | Nom de la route empruntee |
| RoadType | int(3) | Type de route (Annexe N Carrierweb) |
| Accuracy | int | 0 = GPS, -1 = localisation par cellule. Autres valeurs : precision specifique |
| EaiSyncTime | datetime | Heure de synchronisation EAI |
GET/positions/{id}
Detail d'un enregistrement de position par son ID.
Conducteurs
GET/drivers
Liste des conducteurs enregistres dans Carrierweb. La colonne de date utilisee est UpdateTime.
| Parametre | Type | Description |
|---|---|---|
| limit | integer | optionnel — defaut: 100, max: 1000 |
| offset | integer | optionnel — Decalage de pagination |
| since | string | optionnel — Date debut (ISO 8601 ou YYYY-MM-DD) |
| until | string | optionnel — Date fin (ISO 8601 ou YYYY-MM-DD) |
curl -H "X-API-Key: votre-cle" \
"https://api.carrierweb.ma/api/public/v1/drivers?limit=50"
Champs retournes (cwReturnDrivers)
| Champ | Type | Description |
|---|---|---|
| ID / DriverId | bigint | Identifiants internes Carrierweb |
| DriverNumber | char(10) | Numero conducteur (specifique client) |
| MDTLogin | char(15) | Login utilise sur le terminal MDT |
| DriverName | char(36) | Nom complet |
| Salutation | char(20) | Civilite |
| Phone / Email | char | Coordonnees |
| Address / City / Zipcode / Country | char | Adresse postale |
| HomeLocationLat / HomeLocationLong | int | Coordonnees domicile (degres × 100000) |
| Radius / Unit | char | Rayon autour du domicile |
| UpdateID | int | Pour synchronisation incrementale |
| TimeZone | char(56) | Fuseau horaire du conducteur |
| SalaryNumber | char(15) | Numero de paie |
| HOSRegulations | int | Reglementation HOS applicable au conducteur |
| HomeBases | text | Liste des bases d'attache (CSV) |
| MemberState | int | Code numerique pays/region (Annexe J) |
| WebsiteThemeId | int | Theme du site web (Annexe O) |
| DriverCardNumber | char(20) | Numero de carte conducteur EU |
| Locked | tinyint | 0 = actif, 1 = compte verrouille |
| LockTime / LockTimeZone | datetime / int | Heure de verrouillage du compte |
GET/drivers/{id}
Detail d'un conducteur par son UpdateID.
Trajets
GET/trips
Liste des trajets effectues par les vehicules. Les colonnes de date utilisees sont StartTime et EndTime.
| Parametre | Type | Description |
|---|---|---|
| limit | integer | optionnel — defaut: 100, max: 1000 |
| offset | integer | optionnel — Decalage de pagination |
| since | string | optionnel — Date debut (ISO 8601 ou YYYY-MM-DD) |
| until | string | optionnel — Date fin (ISO 8601 ou YYYY-MM-DD) |
curl -H "X-API-Key: votre-cle" \
"https://api.carrierweb.ma/api/public/v1/trips?since=2026-04-01&until=2026-04-30"
Champs retournes (cwReturnTrips)
| Champ | Type | Description |
|---|---|---|
| TripID | int | Numero du trajet (Forward trip number) |
| TripReference | char(20) | Reference du trajet |
| EquipmentType | char(3) | Type d'equipement |
| DispatchTime | datetime | Heure d'envoi des instructions au vehicule (obligatoire) |
| CWTruckID / TruckNumber | int / char(10) | Camion affecte (CWVehicleID + InHouseId) |
| CWDriver0ID / Driver0Number / Driver0Name | int / char | Conducteur principal |
| CWDriver1ID / Driver1Number / Driver1Name | int / char | Co-conducteur |
| CWTrailerID / TrailerNumber | int / char(10) | Remorque attribuee |
| CWContainer0ID / Container0Number | int / char(10) | Conteneur 1 |
| CWContainer1ID / Container1Number | int / char(10) | Conteneur 2 |
| UpdateID | int | Pour synchronisation incrementale |
| SortTime | datetime | Heure d'ordonnancement sur le MDT |
| StartLatitude / StartLongitude | int | Position prevue de debut (degres × 100000) — pour calcul ETA |
| EndLatitude / EndLongitude | int | Position prevue de fin (degres × 100000) — pour calcul ETA |
| ExpectedStartTime | datetime | Heure de debut prevue (utilisee pour ETA jusqu'au demarrage reel) |
| StartTime / EndTime | datetime | Heures de debut et fin reelles |
| CreateTime | datetime | Heure de creation du trajet |
| ServerSideAutoArriveDepart | tinyint | 0 = non, 1 = oui (le trajet n'est pas envoye au vehicule) |
| AutoArriveDepartMode | int | 0 = fin a l'arrivee derniere etape, 1 = fin au depart derniere etape |
GET/trips/{id}
Detail d'un trajet par son UpdateID.
Telemetrie
GET/telemetry
Donnees de telemetrie : temperature, capteurs, etat du vehicule. La colonne de date utilisee est TimeStamp.
| Parametre | Type | Description |
|---|---|---|
| limit | integer | optionnel — defaut: 100, max: 1000 |
| offset | integer | optionnel — Decalage de pagination |
| vehicleid | integer | optionnel — Filtrer par CWVehicleID |
| since | string | optionnel — Date debut (ISO 8601 ou YYYY-MM-DD) |
| until | string | optionnel — Date fin (ISO 8601 ou YYYY-MM-DD) |
curl -H "X-API-Key: votre-cle" \
"https://api.carrierweb.ma/api/public/v1/telemetry?vehicleid=250085&since=2026-02-12&until=2026-02-13"
Champs retournes (cwReturnTelemetry)
| Champ | Type | Description |
|---|---|---|
| ID | bigint | Identifiant unique |
| CWVehicleID / VehicleNumber / VehicleType | int / char | Reference vehicule |
| TransponderID / TransponderDescription | int / char(50) | Capteur ou transpondeur source |
| TelemetryType | int | 20=RFID, 50=Temperature, 60=Porte ouverte, 61=Porte fermee, 80=Humidite, 1001=Carburant CAN, 1008=Niveau carburant |
| MeasuredTime / MeasuredTimeZone | datetime / int | Heure GMT mesuree + fuseau local |
| Value0 / Value1 | int | Valeurs mesurees (selon TelemetryType) |
| ValueString | varchar(255) | Valeur textuelle (utilisee par certains TelemetryType) |
| MinValue / MaxValue | int | Min/Max sur la periode |
| TachoOdometer | int | Odometre tachygraphe |
| PositionReference | bigint | ID de la derniere position avant cet enregistrement |
| LastPositionTime / LastPositionTimeZone | datetime / int | Heure GMT de la derniere position |
| GpsValid | int | Validite GPS |
| Latitude / Longitude | int | Degres decimaux × 100000 |
| EaiSyncTime | datetime | Heure de synchronisation EAI |
GET/telemetry/{id}
Detail d'un enregistrement de telemetrie par son ID.
CAN Bus
GET/canbus
Donnees CAN Bus historiques (consommation carburant, kilometrage, charge moteur...). La colonne de date utilisee est MeasuredTime.
| Parametre | Type | Description |
|---|---|---|
| limit | integer | optionnel — defaut: 100, max: 1000 |
| offset | integer | optionnel — Decalage de pagination |
| vehicleid | integer | optionnel — Filtrer par CWVehicleID |
| since | string | optionnel — Date debut (ISO 8601 ou YYYY-MM-DD) |
| until | string | optionnel — Date fin (ISO 8601 ou YYYY-MM-DD) |
curl -H "X-API-Key: votre-cle" \
"https://api.carrierweb.ma/api/public/v1/canbus?vehicleid=250085&since=2026-02-12&until=2026-02-13"
Champs retournes (cwReturnTruckCanbusHistory)
| Champ | Type | Description |
|---|---|---|
| ID | bigint | Identifiant unique |
| CWVehicleID / VehicleNumber / VehicleType | int / char | Reference vehicule |
| MeasuredTime / MeasuredTimeZone | datetime / int | Heure GMT mesuree |
| CWDriverID / DriverNumber / DriverName | int / char | Conducteur en charge |
| Odometer | int | Odometre (0.1km, 123 = 12.3km) |
| Fuel | int | Carburant consomme (0.1L) |
| CO2 | bigint | CO2 emis (grammes) |
| FuelLevel | int | Niveau de reservoir (0.1%) |
| HighRPM / HighTorque | int | Temps en haut regime / couple eleve |
| CruiseControl | int | Temps en regulateur de vitesse |
| Accelerations / OverSpeed | int | Acceleration brutales / exces de vitesse |
| BrakeApplications / HardBrakeApplications | int | Freinages / freinages durs |
| EngineRollout / EngineRunningTime | int | Roue libre moteur / temps moteur tournant |
| IdleTime / IdleFuel / IdleCO2 | int / bigint | Temps, carburant, CO2 au ralenti |
| PTOTime / PTOFuel / PTOCO2 | int / bigint | Prise de force (Power Take-Off) |
| GreenZoneRPMFuel / Distance / Time | int | Conduite ecoresponsable |
| RetarderDistance / RetarderTime | int | Utilisation du ralentisseur |
| CatalystLevel | int | Niveau AdBlue / catalyseur |
| LongIdleTime | int | Temps de ralenti prolonge (secondes) |
| UnprocessedOdometer | int | Odometre brut ECU non corrige (0.1km) |
GET/canbus/{id}
Detail d'un enregistrement CAN Bus par son ID.
Transpondeurs (site survey RF)
GET/transponders
Donnees de releve RF site survey (tags, positions, RSSI). La colonne de date utilisee est PositionTime.
| Parametre | Type | Description |
|---|---|---|
| limit | integer | optionnel — defaut: 100, max: 1000 |
| offset | integer | optionnel — Decalage de pagination |
| vehicleid | integer | optionnel — Filtrer par CWVehicleID |
| since | string | optionnel — Date debut (ISO 8601 ou YYYY-MM-DD) |
| until | string | optionnel — Date fin (ISO 8601 ou YYYY-MM-DD) |
curl -H "X-API-Key: votre-cle" \
"https://api.carrierweb.ma/api/public/v1/transponders?vehicleid=250085&since=2026-02-12&until=2026-02-13"
Champs retournes (cwReturnSiteSurveyTransponders)
| Champ | Type | Description |
|---|---|---|
| ID | bigint | Identifiant unique |
| CWVehicleID / VehicleNumber / VehicleType | int / char | Reference vehicule |
| SiteSurveyId | int | Identifiant du releve (tous les tags d'un meme relege ont le meme SiteSurveyId) |
| TransponderId | int | ID Carrierweb du transpondeur (0 = tag non defini) |
| ThirdPartyId | int | Identifiant materiel du tag |
| Latitude / Longitude | int | Position (degres decimaux × 100000) |
| PositionTime | datetime | Heure de la position |
| RSSI | int | Force du signal (RSSI) |
GET/transponders/{id}
Detail d'un enregistrement transpondeur par son ID.
Alarmes
GET/alarms
Liste des alarmes declenchees par les vehicules. La colonne de date utilisee est AlarmTime.
| Parametre | Type | Description |
|---|---|---|
| limit | integer | optionnel — defaut: 100, max: 1000 |
| offset | integer | optionnel — Decalage de pagination |
| since | string | optionnel — Date debut (ISO 8601 ou YYYY-MM-DD) |
| until | string | optionnel — Date fin (ISO 8601 ou YYYY-MM-DD) |
curl -H "X-API-Key: votre-cle" \
"https://api.carrierweb.ma/api/public/v1/alarms?since=2026-04-01&until=2026-04-30"
Champs retournes (cwReturnAlarms)
| Champ | Type | Description |
|---|---|---|
| ID | bigint | Identifiant unique de l'alarme |
| CWVehicleID / VehicleNumber / VehicleType | int / char | Reference vehicule |
| AlarmTime / AlarmTimeZone | datetime / int | Heure GMT de l'alarme + fuseau local |
| AlarmType | int | Type d'alarme (voir Annexe H Carrierweb) |
| Value1 | int | Valeur numerique (sens depend du type) |
| Value2 | varchar(255) | Valeur textuelle (sens depend du type) |
| Latitude / Longitude | int | Position au moment de l'alarme (degres × 100000) |
| Country | varchar(4) | Code ISO pays / etat |
| Location / Zipcode | varchar | Ville la plus proche et code postal |
| ProximityDistance / ProximityDirection | int | Distance et direction vers Location |
| LandmarkID | bigint | Point de repere lie (cwReturnLandmarks.ID) |
| AlarmSubType | int | Pour AlarmType 600 (Reefer) : 0=indef, 11=Carrier Advanced, 12=Carrier Summit, 20=ThermoKing, 30=SuperCool |
GET/alarms/{id}
Detail d'une alarme par son ID.
Activites vehicules
GET/activities
Activites des vehicules : mouvements, arrets, changements d'etat. La colonne de date utilisee est TimeStamp.
| Parametre | Type | Description |
|---|---|---|
| limit | integer | optionnel — defaut: 100, max: 1000 |
| offset | integer | optionnel — Decalage de pagination |
| since | string | optionnel — Date debut (ISO 8601 ou YYYY-MM-DD) |
| until | string | optionnel — Date fin (ISO 8601 ou YYYY-MM-DD) |
curl -H "X-API-Key: votre-cle" \
"https://api.carrierweb.ma/api/public/v1/activities?since=2026-04-20"
Champs retournes (cwReturnActivities)
| Champ | Type | Description |
|---|---|---|
| ID / ExportID / NextActivityID | bigint | Identifiants internes / chainage des activites |
| CWVehicleID / VehicleNumber / VehicleType | int / char | Reference vehicule |
| StartTime / StartTimeZone | datetime / int | Debut de l'activite (GMT + fuseau local) |
| EndTime / EndTimeZone | datetime / int | Fin de l'activite (non corrigee) |
| ActivityId | int | Type d'activite (Conduite, Chargement, etc.) |
| ActivityName | varchar(56) | Libelle de l'activite |
| SubActivityId | int | Toujours 0 (non utilise) |
| MinTime / MaxTime | int | Bornes temporelles |
| CWDriver0ID / Driver0Number / Driver0Name | int / char | Conducteur principal |
| CWDriver1ID / Driver1Number / Driver1Name | int / char | Co-conducteur |
| CWVehicleTripID / TripNumber / HOSTripNumber | bigint / char | Reference trajet vehicule |
| TripID / JobID | int | Reference trajet/job du module consignment |
| HomeBase | int | 0 = hors base, 1 = en base, 2 = domicile, >2 = base custom |
| StartLatitude / StartLongitude | int | Position au debut (degres × 100000) |
| StartCountry / StartLocation / StartZipCode | varchar | Localisation de debut |
| StartProximityDistance / StartProximityDirection | int | Proximite de debut |
| StartGPSOdometer / StartTachoOdometer | int | Odometres au debut |
| StartFuel / StartCO2 / StartFuelLevel | int / bigint | Carburant et CO2 au debut |
| StartLandmarkId | bigint | Point de repere au debut |
| EndLatitude / EndLongitude | int | Position de fin (degres × 100000) |
| EndCountry / EndLocation / EndZipCode | varchar | Localisation de fin |
| EndProximityDistance / EndProximityDirection | int | Proximite de fin |
| EndGPSOdometer / EndTachoOdometer | int | Odometres a la fin |
| EndFuel / EndCO2 / EndFuelLevel | int / bigint | Carburant et CO2 a la fin |
| EndLandmarkId | bigint | Point de repere a la fin |
| CorrectedDuration | int | Duree corrigee en secondes (cloture journaliere uniquement) |
| Trailer / CWTrailerID | varchar / int | Remorque attachee |
| CreationType | int | 1 = HOS embarque, 3 = serveur (minuit, etc.) |
| LoggingCategory | int | 0=indef, 1=off duty, 2=sleeper, 3=on duty driving, 4=on duty not driving |
| LoggingCategoryInactiveDriver | int | Categorie du conducteur inactif |
| TripCustomer | char(20) | Client du trajet (saisie chauffeur) |
| VehicleDescription | char(56) | Description du vehicule |
| Deleted | tinyint | 0 = non modifie, 1 = supprime, 2 = mis a jour, 3 = insere |
GET/activities/{id}
Detail d'une activite par son ExportID.
Points de repere
GET/landmarks
Points de repere (zones, sites, depots) configures dans Carrierweb.
| Parametre | Type | Description |
|---|---|---|
| limit | integer | optionnel — defaut: 100, max: 1000 |
| offset | integer | optionnel — Decalage de pagination |
| since | string | optionnel — Date debut (ISO 8601 ou YYYY-MM-DD) |
| until | string | optionnel — Date fin (ISO 8601 ou YYYY-MM-DD) |
curl -H "X-API-Key: votre-cle" \
"https://api.carrierweb.ma/api/public/v1/landmarks"
Champs retournes (cwReturnLandmarks)
| Champ | Type | Description |
|---|---|---|
| ID | bigint | Identifiant unique du point de repere |
| Description | char(255) | Nom / description du repere |
| Latitude / Longitude | int | Coordonnees centrale (degres × 100000) |
| Radius / RadiusUnit | int | Rayon de la zone et son unite |
| Type | int | 1=Client, 2=Base, 3=Bureau, 4=Frontiere, 5=Ferry, 6=Gare, 7=Aire de repos, 8=Station-service, 9=Depot, 99=Autre |
| Polygon / Nodes | tinyint / text | Polygone defini (si Polygon=1, Nodes liste les sommets) |
| Deleted | int | 1 = supprime, 0 = actif |
| UpdateID | bigint | Pour synchronisation incrementale |
| MaxStay | int | Duree max de stationnement autorisee |
| GenerateAlarmEntry / Departure | int | Generer alarme a l'entree / sortie |
| GenerateEmailEntry / Departure | int | Generer email a l'entree / sortie |
| GenerateTemplateEntry / Departure | int | Generer message template a l'entree / sortie |
| EMailEntry / EMailDeparture | char(100) | Adresses email destinataires |
| GroupID | int | Groupe de reperes (cf. /landmarkgroups) |
GET/landmarks/{id}
Detail d'un point de repere par son UpdateID.
GET/landmarkgroups
Groupes de points de repere configures dans Carrierweb.
curl -H "X-API-Key: votre-cle" \
"https://api.carrierweb.ma/api/public/v1/landmarkgroups"
Champs retournes (cwReturnLandmarkGroups)
| Champ | Type | Description |
|---|---|---|
| UpdateID | bigint | Identifiant pour synchronisation incrementale |
| GroupID | int | Identifiant du groupe |
| RootID | int | Identifiant du groupe parent (hierarchie) |
| Description | text | Nom / description du groupe |
GET/landmarkgroups/{id}
Detail d'un groupe de points de repere par son UpdateID.
Pagination & filtres
Tous les endpoints de liste supportent la pagination via limit et offset, et le filtrage par date via since / until (ou alias after / before). Le filtre par vehicule vehicleid est disponible sur les ressources positions, canbus, telemetry et vehicles.
| Parametre | Defaut | Max | Description |
|---|---|---|---|
| limit | 100 | 1000 | Nombre de resultats par page |
| offset | 0 | — | Decalage pour la pagination |
| since | — | — | Date debut — ISO 8601 ou YYYY-MM-DD |
| until | — | — | Date fin — ISO 8601 ou YYYY-MM-DD |
| vehicleid | — | — | Filtrer par CWVehicleID (integer) |
La reponse inclut un objet pagination avec le champ hasMore pour determiner s'il reste des pages :
curl -H "X-API-Key: votre-cle" \
"https://api.carrierweb.ma/api/public/v1/positions?limit=500&offset=500&since=2026-04-01"
Colonnes de date par ressource
| Ressource | Colonne de date (since/until) |
|---|---|
| vehicles / vehiclesBase | LastPositionTime, LastMessageTime, UpdateTime |
| positions | MeasuredTime |
| trips | StartTime, EndTime, UpdateTime |
| drivers | UpdateTime |
| alarms | AlarmTime, AcknowledgeTime |
| activities | TimeStamp, ActivityTime |
| telemetry | TimeStamp, MeasuredTime |
| canbus | MeasuredTime |
| landmarks | — (pas de colonne de date) |
Polling incremental
Pour recuperer uniquement les nouvelles donnees depuis votre derniere synchronisation, utilisez
since=2026-04-27T08:00:00Z avec limit=1000. Bouclez en incrementant offset tant que hasMore est true.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 |
Exemples d'integration
cURL
# Liste des vehicules
curl -H "X-API-Key: votre-cle" "https://api.carrierweb.ma/api/public/v1/vehicles?limit=50"
# Positions d'un vehicule sur une journee
curl -H "X-API-Key: votre-cle" \
"https://api.carrierweb.ma/api/public/v1/positions?vehicleid=250085&since=2026-04-27&until=2026-04-28"
# Toutes les alarmes du mois
curl -H "X-API-Key: votre-cle" \
"https://api.carrierweb.ma/api/public/v1/alarms?since=2026-04-01&until=2026-04-30"
# Pagination : page 3 (offset=200, limit=100)
curl -H "X-API-Key: votre-cle" \
"https://api.carrierweb.ma/api/public/v1/trips?limit=100&offset=200"
JavaScript (fetch)
const API_KEY = 'votre-cle';
const BASE = 'https://api.carrierweb.ma/api/public/v1';
async function apiGet(path) {
const res = await fetch(BASE + path, {
headers: { 'X-API-Key': API_KEY }
});
return res.json();
}
// Recuperer tous les vehicules (avec pagination automatique)
async function getAllVehicles() {
let all = [], offset = 0;
while (true) {
const r = await apiGet('/vehicles?limit=1000&offset=' + offset);
if (!r.success) throw new Error(r.message);
all = all.concat(r.data.vehicles);
if (!r.data.pagination.hasMore) break;
offset += 1000;
}
return all;
}
Python
import requests
API_KEY = 'votre-cle'
BASE_URL = 'https://api.carrierweb.ma/api/public/v1'
HEADERS = {'X-API-Key': API_KEY}
def get_vehicles():
resp = requests.get(f'{BASE_URL}/vehicles', headers=HEADERS, params={'limit': 100})
resp.raise_for_status()
return resp.json()['data']['vehicles']
def get_positions(vehicle_id, since, until):
resp = requests.get(
f'{BASE_URL}/positions',
headers=HEADERS,
params={'vehicleid': vehicle_id, 'since': since, 'until': until, 'limit': 1000}
)
resp.raise_for_status()
return resp.json()['data']['positions']
vehicles = get_vehicles()
positions = get_positions(250085, '2026-04-27', '2026-04-28')
PHP
$apiKey = 'votre-cle';
$baseUrl = 'https://api.carrierweb.ma/api/public/v1';
function cwEaiGet(string $path, string $apiKey, string $baseUrl): array {
$ctx = stream_context_create(['http' => [
'header' => 'X-API-Key: ' . $apiKey
]]);
$json = file_get_contents($baseUrl . $path, false, $ctx);
return json_decode($json, true);
}
// Recuperer les vehicules
$result = cwEaiGet('/vehicles?limit=100', $apiKey, $baseUrl);
foreach ($result['data']['vehicles'] as $v) {
echo $v['VehicleNumber'] . PHP_EOL;
}
Limites et bonnes pratiques
| Limite | Valeur |
|---|---|
| Resultats max par requete | 1 000 enregistrements |
| Protocole | HTTPS obligatoire |
| Authentification | Cle API par tenant — ne pas partager |
| Frequence recommandee | 1 appel / minute maximum par ressource |
Securite
Ne stockez jamais votre cle API dans le code source ou dans un depot Git public. Utilisez des variables d'environnement ou un gestionnaire de secrets.