Format de réponse
Structure standard des réponses JSON de l'API.
Structure standard
Toutes les réponses de l'API suivent une structure JSON uniforme, facilitant le parsing et la gestion des erreurs.
Réponse réussie (200)
{
"success": true,
"data": {
// Données spécifiques à l'endpoint
},
"timestamp": "2026-02-08T12:00:00.000Z",
"meta": {
"totalResults": 42,
"currentPage": 1,
"totalPages": 3,
"responseTime": 250
}
}Champs de la réponse
| Champ | Type | Description |
|---|---|---|
success | boolean | Indique si la requête a réussi |
data | object | null | Données de réponse spécifiques à l'endpoint. null en cas d'erreur. |
error | string | undefined | Message d'erreur. Présent uniquement en cas d'échec. |
timestamp | string (ISO 8601) | Horodatage de la réponse au format ISO 8601 |
meta | object | Métadonnées (pagination, temps de réponse) |
meta.totalResults | integer | Nombre total de résultats (endpoints de recherche) |
meta.currentPage | integer | Page courante |
meta.totalPages | integer | Nombre total de pages |
meta.responseTime | number (ms) | Temps de réponse en millisecondes |
Réponse d'erreur
En cas d'erreur, le champ success est false et un message d'erreur est fourni :
Réponse d'erreur (400)
{
"success": false,
"error": "At least one search parameter is required (name, zipCode, city, or naceCode)",
"timestamp": "2026-02-08T12:00:00.000Z"
}Pagination
Les endpoints de recherche retournent des résultats paginés. Utilisez le paramètre page pour naviguer entre les pages.
Pagination
// Première page GET /api/companies/search?name=software&page=1 // Deuxième page GET /api/companies/search?name=software&page=2
Les champs meta.totalPages et meta.currentPage vous permettent de gérer la navigation.