Documentation de l'API — v1

Espace développeur

Base URL

https://api-manutest.sipco.fr/api/v1

Authentification

Toutes les requêtes (sauf /health) nécessitent une clé API transmise dans l’en-tête :

x-api-key: VOTRE_CLE_API

Sans cet en-tête, l’API renvoie 401 Unauthorized.

Pour obtenir votre clé API, voyez contacter SIPCO : 02 99 76 16 16

Exemple rapide

curl -X GET "https://api-manutest.sipco.fr/api/v1/clients?limit=10" \
     -H "x-api-key: sk_live_123456789abcdef..."

Pagination

Les endpoints listant des ressources utilisent une pagination basée surlimit etoffset.

Paramètres de pagination

Paramètre	Type	Description
limit	number	Nombre maximum d’éléments retournés (par défaut 50, maximum 200)
offset	number	Index de départ (0 = début de la liste)

L’API ne permet pas de récupérer l’ensemble des données en une seule requête.
Il est nécessaire d’utiliser la pagination (limit / offset) jusqu’à ce que pagination.nextOffset soit null.

Structure de la réponse

En plus des données, l’API retourne un objetpaginationcontenant les informations nécessaires pour parcourir toutes les pages.

{
  "data": [ ... ],
  "pagination": {
    "limit": 100,
    "offset": 400,
    "count": 100,
    "total": 8437,
    "hasMore": true,
    "nextOffset": 500
  }
}

total : nombre total d’éléments disponibles
count : nombre d’éléments retournés sur cette page
hasMore : indique s’il reste des pages à charger
nextOffset : valeur à utiliser pour la page suivante (ou null)

Exemple de navigation

GET /api/v1/vehicles?limit=100&offset=0
GET /api/v1/vehicles?limit=100&offset=100
GET /api/v1/vehicles?limit=100&offset=200
...

Endpoints disponibles

GET /health

Endpoint de santé permettant de tester votre connexion à l'API (non protégé) : /api/v1/health

GET /clients

Récupère la liste des clients/transporteurs.

Paramètres (query)

Nom	Type	Description
limit	number	(Optionnel) Nombre maximum de résultats
search	string	(Optionnel) Recherche par nom ou email

curl -X GET "https://api-manutest.sipco.fr/api/v1/clients?limit=10" \
     -H "x-api-key: sk_live_123456789abcdef..."

Réponse JSON

{
  "data": [
    {
      "trpid": 1,
      "trpnom": "Dupont SARL",
      "trpmail": "contact@dupont.fr",
      "trptel": "02 99 00 00 00"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "count": 1,
    "total": 128,
    "hasMore": true,
    "nextOffset": 10
  }
}

GET /vehicles

Récupère la liste des véhicules associés à un prestataire.

Paramètres (query)

Nom	Type	Description
limit	number	(Optionnel) Nombre maximum de résultats
immat	string	(Optionnel) Immatriculation du véhicule
prestnom	string	(Optionnel) Nom du prestataire

curl -X GET "https://api-manutest.sipco.fr/api/v1/vehicles?limit=2" \
    -H "x-api-key: 123456789abcdef..."

Réponse JSON

{
  "data": [
    {
      "vehid": 3,
      "vehimmat": "AB-123-CD",
      "vehmodel": "MASTER",
      "vehmarq": 304,
      "vehmarqlib": "RENAULT",
      "vehcat": 4
    }
  ],
  "pagination": {
    "limit": 2,
    "offset": 0,
    "count": 1,
    "total": 8437,
    "hasMore": true,
    "nextOffset": 2
  }
}

Autres endpoints liés

Liste les véhicules d'un transporteurs en particulier :/v1/transp/:id/vehicles
Liste tous les loueurs associés au partenaire : /v1/loueurs
Liste tous les véhicules des loueurs associés au partenaire : /v1/loueurs/vehicles
Liste tous les véhicules d'un loueur en particuler : /v1/loueurs/:id/vehicles

Codes de réponse

Code	Signification	Description
200	OK	Requête réussie
400	Bad Request	Paramètres invalides
401	Unauthorized	Clé API absente ou incorrecte
404	Not Found	Ressource introuvable
500	Server Error	Erreur interne du serveur (contacter Sipco)