Documentation API v1
L'API de Check-list Pro est organisée autour du protocole REST. Elle vous permet de connecter vos propres systèmes de gestion de flotte (ERP, TMS) à notre plateforme pour automatiser la synchronisation des données de vos inspections.
Base URL de l'API
https://api.checklist-pro.com/v1Authentification
Toutes les requêtes vers l'API de Check-list Pro doivent être authentifiées. Pour cela, transmettez votre clé secrète dans le header HTTP Authorization sous la forme d'un Bearer token.
Gardez vos clés privées secrètes. Ne les exposez jamais dans du code côté client (navigateurs, applications mobiles) ni dans des répertoires Git publics.
Erreurs & Codes
L'API utilise les codes HTTP standards pour indiquer le succès ou l'échec d'une requête. Les codes de la série 2xx indiquent un succès, ceux de la série 4xx une erreur client, et 5xx une erreur serveur.
| Code | Signification |
|---|---|
| 200 OK | La requête s'est déroulée avec succès. |
| 201 Created | La ressource a été créée avec succès. |
| 400 Bad Request | La requête est mal formée ou des paramètres requis sont manquants. |
| 401 Unauthorized | Pas de clé API valide fournie dans le header Authorization. |
| 403 Forbidden | La clé API n'a pas les droits nécessaires pour effectuer cette action. |
| 404 Not Found | La ressource demandée n'existe pas. |
Lister les rapports
/v1/inspectionsRécupère l'historique paginé de toutes les inspections et contrôles de sécurité effectués par vos conducteurs.
Paramètres Query
Plaque d'immatriculation du véhicule à filtrer (ex: AB-123-CD).
Nombre maximum de résultats par page. Valeur par défaut : 20, maximum : 100.
Numéro de page pour la pagination des résultats (Défaut : 1).
Détail d'une inspection
/v1/inspections/:idRécupère les informations complètes d'un rapport de contrôle spécifique à partir de son identifiant unique.
Paramètres URL
L'identifiant unique du rapport d'inspection (ex: insp_9f1a2).
Lister le parc de véhicules
/v1/vehiclesRécupère la liste de tous les véhicules (tracteurs, remorques, utilitaires) de votre entreprise enregistrés dans Check-list Pro.
Paramètres Query
Type de véhicule à filtrer. Valeurs possibles : truck (tracteur), trailer (remorque).
Nombre max de résultats renvoyés par requête. Valeur par défaut : 20, maximum : 100.
Ajouter un véhicule
/v1/vehiclesImportez ou créez un nouveau véhicule (tracteur ou remorque) directement dans votre parc sur Check-list Pro depuis votre logiciel TMS/ERP.
Corps de la Requête (JSON)
Plaque d'immatriculation unique du véhicule (ex: XY-987-ZZ).
Le type du véhicule. Valeurs possibles : truck (tracteur), trailer (remorque).
Marque du constructeur (ex: Renault, Volvo, Schmitz Cargobull).
Modèle exact du véhicule.
Mettre à jour un véhicule
/v1/vehicles/:idMet à jour les informations d'un véhicule spécifique de votre parc en fournissant les attributs modifiés.
Paramètres URL
L'identifiant unique du véhicule à modifier (ex: veh_a12b3).
Corps de la Requête (JSON)
La marque mise à jour du constructeur.
Le modèle mis à jour du véhicule.
Besoin d'aller plus loin ?
L'intégration de notre API REST publique est réservée exclusivement à nos clients Premium. Discutez de vos cas d'usage ou demandez une clé de test.
Demander une clé de test