Format de reponse
Toutes les reponses de l'API v2 suivent une structure JSON uniforme. Le champ Content-Type est toujours application/json.
Structure standard
Chaque reponse contient au minimum les champs success, timestamp, et selon le cas data ou error.
| Champ | Type | Description |
|---|---|---|
success | boolean | Indique si la requete a abouti avec succes |
data | object | array | null | Donnees retournees en cas de succes. Absent en cas d'erreur. |
error | string | undefined | Message d'erreur lisible. Present uniquement si success est false. |
timestamp | string (ISO 8601) | Date et heure de la reponse au format ISO 8601 |
Reponse en cas de succes
Lorsque la requete aboutit, success vaut true et les donnees sont disponibles dans le champ data.
200 OK — Succes
{
"success": true,
"data": {
"enterpriseNumber": "1033022383",
"status": "AC",
"juridicalForm": "014",
"startDate": "2024-01-15",
"denominations": [
{
"language": "1",
"typeOfDenomination": "001",
"denomination": "ESPERO-SOFT INFORMATIQUES"
}
],
"addresses": [...]
},
"timestamp": "2026-04-17T12:00:00.000Z"
}Reponse en cas d'erreur
En cas d'erreur, success vaut false et un message explicatif est fourni dans le champ error. Le champ data est absent.
404 Not Found — Erreur
{
"success": false,
"error": "Enterprise not found",
"timestamp": "2026-04-17T12:00:00.000Z"
}Pagination
Certains endpoints qui retournent des listes supportent la pagination via les parametres limit et offset.
| Parametre | Type | Description |
|---|---|---|
limit | integer | Nombre maximum de resultats a retourner (defaut : 20, max : 100) |
offset | integer | Nombre de resultats a ignorer avant de commencer le retour (defaut : 0) |
Exemple de pagination
# Premiere page (20 resultats) GET /api/v2/denominations?q=software&limit=20&offset=0 # Deuxieme page GET /api/v2/denominations?q=software&limit=20&offset=20 # Troisieme page GET /api/v2/denominations?q=software&limit=20&offset=40
En-tetes de quota
Chaque reponse inclut des en-tetes HTTP indiquant votre consommation de quota. Ces en-tetes vous permettent de surveiller votre utilisation sans appel supplementaire.
| En-tete | Description |
|---|---|
X-RateLimit-Limit | Nombre maximum de requetes autorisees dans la fenetre courante |
X-RateLimit-Remaining | Nombre de requetes restantes dans la fenetre courante |
X-RateLimit-Reset | Timestamp Unix (en secondes) indiquant quand la fenetre sera reinitialise |
Exemple de reponse avec en-tetes
HTTP/1.1 200 OK
Content-Type: application/json
X-RateLimit-Limit: 500
X-RateLimit-Remaining: 487
X-RateLimit-Reset: 1713362400
{
"success": true,
"data": { ... },
"timestamp": "2026-04-17T12:00:00.000Z"
}