Bêta FerméeL'API REST est en cours de développement.Demander un accès anticipé →
API Reference v1

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/v1
HTTP Header Info
HeaderType
Accept:application/json
Content-Type:application/json
Disponible prochainement

Authentification

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.

Sécurité des clés API

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.

Exemple de Header
// Header requisAuthorization: "Bearer sec_live_8f92ac..."
Disponible prochainement

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.

CodeSignification
200 OKLa requête s'est déroulée avec succès.
201 CreatedLa ressource a été créée avec succès.
400 Bad RequestLa requête est mal formée ou des paramètres requis sont manquants.
401 UnauthorizedPas de clé API valide fournie dans le header Authorization.
403 ForbiddenLa clé API n'a pas les droits nécessaires pour effectuer cette action.
404 Not FoundLa ressource demandée n'existe pas.
Format de réponse d'erreur
{
"success": false,
"error": {
"code": "unauthorized",
"message": "Invalid API Key"
}
}
Disponible prochainement

GET

Lister les rapports

/v1/inspections

Récupère l'historique paginé de toutes les inspections et contrôles de sécurité effectués par vos conducteurs.

Paramètres Query

vehicle_platestring

Plaque d'immatriculation du véhicule à filtrer (ex: AB-123-CD).

limitintegerOptionnel

Nombre maximum de résultats par page. Valeur par défaut : 20, maximum : 100.

pageinteger

Numéro de page pour la pagination des résultats (Défaut : 1).

cURL
curl -X GET \
"https://api.checklist-pro.com/v1/inspections?vehicle_plate=AB-123-CD" \
-H "Authorization: Bearer sec_live_8f92a..."
Disponible prochainement
Exemple de Réponse (200 OK)
{
"success": true,
"data": [
{
"id": "insp_9f1a2",
"vehicle_plate": "AB-123-CD",
"condition": "conforme",
"driver_name": "Jean Dupont",
"created_at": "2026-06-19T10:00:00Z"
}
],
"meta": {
"current_page": 1,
"total_pages": 3,
"total_results": 54
}
}
Disponible prochainement

GET

Détail d'une inspection

/v1/inspections/:id

Récupère les informations complètes d'un rapport de contrôle spécifique à partir de son identifiant unique.

Paramètres URL

idstringRequis

L'identifiant unique du rapport d'inspection (ex: insp_9f1a2).

cURL
curl -X GET \
"https://api.checklist-pro.com/v1/inspections/insp_9f1a2" \
-H "Authorization: Bearer sec_live_8f92a..."
Disponible prochainement
Exemple de Réponse (200 OK)
{
"success": true,
"data": {
"id": "insp_9f1a2",
"vehicle_plate": "AB-123-CD",
"driver": {
"name": "Jean Dupont",
"email": "jean.dupont@transport.com"
},
"status": "conforme",
"checklist": [
{ "item": "Freinage", "ok": true },
{ "item": "Pneumatiques", "ok": true }
],
"created_at": "2026-06-19T10:00:00Z"
}
}
Disponible prochainement

GET

Lister le parc de véhicules

/v1/vehicles

Récupère la liste de tous les véhicules (tracteurs, remorques, utilitaires) de votre entreprise enregistrés dans Check-list Pro.

Paramètres Query

vehicle_typestring

Type de véhicule à filtrer. Valeurs possibles : truck (tracteur), trailer (remorque).

limitinteger

Nombre max de résultats renvoyés par requête. Valeur par défaut : 20, maximum : 100.

cURL
curl -X GET \
"https://api.checklist-pro.com/v1/vehicles?vehicle_type=truck" \
-H "Authorization: Bearer sec_live_8f92a..."
Disponible prochainement
Exemple de Réponse (200 OK)
{
"success": true,
"data": [
{
"id": "veh_a12b3",
"license_plate": "XY-987-ZZ",
"vehicle_type": "truck",
"brand": "Renault",
"model": "T High"
}
]
}
Disponible prochainement

POST

Ajouter un véhicule

/v1/vehicles

Importez 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)

license_platestringRequis

Plaque d'immatriculation unique du véhicule (ex: XY-987-ZZ).

vehicle_typestringRequis

Le type du véhicule. Valeurs possibles : truck (tracteur), trailer (remorque).

brandstring

Marque du constructeur (ex: Renault, Volvo, Schmitz Cargobull).

modelstring

Modèle exact du véhicule.

cURL
curl -X POST \
"https://api.checklist-pro.com/v1/vehicles" \
-H "Authorization: Bearer sec_live_8f92a..." \
-H "Content-Type: application/json" \
-d '{
"license_plate": "XY-987-ZZ",
"vehicle_type": "truck",
"brand": "Renault",
"model": "T High"
}'
Disponible prochainement
Exemple de Réponse (201 Created)
{
"success": true,
"data": {
"id": "veh_a12b3",
"license_plate": "XY-987-ZZ",
"vehicle_type": "truck",
"brand": "Renault",
"model": "T High",
"created_at": "2026-06-19T14:27:00Z"
}
}
Disponible prochainement

PUT

Mettre à jour un véhicule

/v1/vehicles/:id

Met à jour les informations d'un véhicule spécifique de votre parc en fournissant les attributs modifiés.

Paramètres URL

idstringRequis

L'identifiant unique du véhicule à modifier (ex: veh_a12b3).

Corps de la Requête (JSON)

brandstring

La marque mise à jour du constructeur.

modelstring

Le modèle mis à jour du véhicule.

cURL
curl -X PUT \
"https://api.checklist-pro.com/v1/vehicles/veh_a12b3" \
-H "Authorization: Bearer sec_live_8f92a..." \
-H "Content-Type: application/json" \
-d '{
"model": "T High E-Tech"
}'
Disponible prochainement
Exemple de Réponse (200 OK)
{
"success": true,
"data": {
"id": "veh_a12b3",
"license_plate": "XY-987-ZZ",
"vehicle_type": "truck",
"brand": "Renault",
"model": "T High E-Tech",
"updated_at": "2026-06-19T14:30:00Z"
}
}
Disponible prochainement

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