{% extends 'AppBundle:Admin:CRUD\\Page\\Api\\Vehicle\\layout.html.twig' %} {% block content %}
Ce document décrit l’interface programmatique, ou API, des différentes fonctionnalités de la plateforme KEPLER SOFT.
Les services de KEPLER SOFT permettent de récupérer certaines données de la plateforme. Fonctionnant comme le service web, il permet principalement de récupérer les données des véhicules disponibles sur la plateforme KEPLER SOFT. L'interrogation au service se fait via le protocole HTTP avec la méthode GET.
Le point d'entrée de l'API REST a pour URL: {{ app.request.getSchemeAndHttpHost() }}/api/
L’accès aux services KEPLER SOFT est géré par une clé API qui doit être fournie à chaque requête: {{ app.request.getSchemeAndHttpHost() }}/api/{version}/api-key/{apiKey}/
Il s'agit également de la base de toutes les URLs présentes dans ce document.
Paramètre | Description |
---|---|
version | Le numéro de la version de l’API que vous souhaitez appeler. Ce paramètre est obligatoire Exemple : « {{ currentApiVersion }} » |
apiKey | Votre clé d’API. Elle est utilisée pour authentifier votre compte. Ce paramètre est obligatoire |
Le but principal de l'API KEPLER SOFT est de pouvoir diffuser la liste des véhicules présents sur la plateforme. Vous trouverez ci-dessous la description de ce service permettant de récupérer la liste de véhicules.
Afin de récupérer un ou plusieurs véhicules, vous devez effectuer une requête HTTP à l’url suivante: GET {{ app.request.getSchemeAndHttpHost() }}/api/{version}/api-key/{apiKey}/vehicles/
Exemple: {{ app.request.getSchemeAndHttpHost() }}/api/{version}/api-key/{apiKey}/vehicles/?page=1&count=10&orderBy%5bbrand%5d=DESC&dateUpdatedStart=2016-01-01
{% include 'AppBundle:Admin:CRUD\\Page\\Api\\Layout\\Include\\include_rate_limit.html.twig' %}Paramètre GET | Type | Description | Commentaires |
---|---|---|---|
version | Alphanumérique | Le numéro de la version de l’API que vous souhaitez appeler. Ce paramètre est obligatoire |
Valeur possibles: v1 |
apiKey | Alphanumérique | Votre clé d’API. Elle est utilisée pour authentifier votre compte. Ce paramètre est obligatoire |
Contacter Kepler Solutions pour obtenir votre clé API. |
page | Numérique | Le numéro de la page que vous souhaitez récupérer. Une page correspond à une liste de véhicules. (Voir paramètre count). Ce paramètre est optionnel |
Si non défini, la valeur de « page » sera par défaut à 1. |
count | Numérique | Le nombre de véhicules désirés sur la page demandée. (Voir paramètre page). Ce paramètre est optionnel |
Si non défini, la valeur de « count » sera par défaut à 10. Ce paramètre ne peut dépasser 100. Si besoin de récupérer plus d'éléments, utilisez le paramètre page ci-dessus. |
dateUpdatedStart | Date | Permet de récupérer les véhicules qui ont été modifiés après cette date (strictement supérieur). Ce paramètre est optionnel |
Exemple : 2015-12-01 |
dateUpdatedEnd | Date | Permet de récupérer les véhicules qui ont été modifiés avant cette date (strictement inférieur). | Exemple : 2015-12-01 |
orderBy [parameter] | Alphabétique | Permet de récupérer la liste des véhicules dans un certain ordre. Le paramètre « orderBy » doit prendre une clé « parameter » pour savoir sur quelle donnée le tri doit se baser. Ce paramètre est optionnel Exemple : orderBy[brand] = DESC |
Valeurs possibles pour la clé parameter : dateCreated, state, brand, model, version Valeurs possibles pour orderBy : ASC, DESC |
vo | Alphanumérique | Filtre sur le N°VO d’un véhicules désirés. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’un N°VO particulier. Ce paramètre est optionnel. |
|
state | Alphabétique | Filtre sur les statuts des véhicules désirés. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’un ou plusieurs statuts particuliers. Si vous désirez plusieurs états, concaténez les états désirés par une ",". Ce paramètre est optionnel. |
Voir détail |
vin | Alphanumérique | Filtre sur le VIN des véhicules désirés. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’un VIN particulier. Ce paramètre est optionnel. |
Voir détail |
brand | Alphanumérique | Filtre sur la marque des véhicules désirés. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’une marque particulière. Ce paramètre est optionnel. |
Voir détail |
model | Alphanumérique | Filtre sur le modèle des véhicules désirés. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’un modèle particulier. Ce paramètre est optionnel. |
Voir détail |
version | Alphanumérique | Filtre sur la version des véhicules désirés. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’une version particulière. Ce paramètre est optionnel. |
Voir détail |
siret | Numérique | Filtre sur la société dont les véhicules appartiennent. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’une société particulière. Ce paramètre est optionnel. |
Voir détail |
sharedVehicle | Booléen | Filtre sur les véhicules issus d'un partage. En passant ce paramètre, vous pouvez récupérer seulement les véhicules issus d'un partage. Ce paramètre est optionnel. |
L’API REST renvoie une réponse au format JSON. Vous trouverez ci-dessous la liste des variables qui seront retournées par ce service :
Variable | Type | Description | Commentaires |
---|---|---|---|
totalResult | Numérique | Nombre total de véhicules | |
nbPageList | Numérique | Nombre total de pages | |
createdAt | Date | Date de création du véhicule | |
updatedAt | Date | Date de modification du véhicule | |
reference | Alphanumérique | N° dossier du véhicule (Clé unique du véhicule) | |
internalReference | Alphanumérique | N° dossier interne du véhicule | |
state | Alphabétique | Cycle de vie du véhicule (PARC, VENDU, SORTI, etc…) | Voir table de correspondance |
typeVoVn | Alphabétique | Type du véhicule (Véhicule d’occasions, véhicules neufs, 0 KM) |
Valeurs possibles de base : {% set parameterListValue = '' %} {% for parameter in parameterList[constant("AppBundle\\Entity\\Parameter\\ParameterList::PARAMETER_TYPE_VO_VN")] %} {% set parameterListValue = parameterListValue ~ parameter.name ~ '|' %} {% endfor %} {{ parameterListValue[0:-1] }} |
vehicleType | Alphabétique | Type du véhicule (Véhicule particulier, Véhicule utilitaire) |
Valeurs possibles de base : {% set parameterListValue = '' %} {% for parameter in parameterList[constant("AppBundle\\Entity\\Parameter\\ParameterList::PARAMETER_VEHICLE_TYPE")] %} {% set parameterListValue = parameterListValue ~ parameter.name ~ '|' %} {% endfor %} {{ parameterListValue[0:-1] }} |
vin | Alphanumérique | Numéro de série du véhicule | |
vo | Numérique | Numéro de vo du véhicule | |
licenseNumber | Alphanumérique | Immatriculation du véhicule | |
brand: {name} | Alphanumérique | Marque du véhicule | |
model: {name} | Alphanumérique | Modèle du véhicule | |
country | Alphabétique | Pays du véhicule | Voir table de correspondance |
version : {name} | Alphanumérique | Version du véhicule | |
energy : {name} | Alphanumérique | Energie du véhicule |
Valeurs possibles de base : {% set parameterListValue = '' %} {% for parameter in parameterList[constant("AppBundle\\Entity\\Parameter\\ParameterList::PARAMETER_FUEL")] %} {% set parameterListValue = parameterListValue ~ parameter.name ~ '|' %} {% endfor %} {{ parameterListValue[0:-1] }} |
firstHand | Booléen | Première main | |
bodywork : {name} | Alphanumérique | Carrosserie du véhicule |
Valeurs possibles de base : {% set parameterListValue = '' %} {% for parameter in parameterList[constant("AppBundle\\Entity\\Parameter\\ParameterList::PARAMETER_BODYWORK")] %} {% set parameterListValue = parameterListValue ~ parameter.name ~ '|' %} {% endfor %} {{ parameterListValue[0:-1] }} |
gearbox : {name} | Alphanumérique | Boîte |
Valeurs possibles de base : {% set parameterListValue = '' %} {% for parameter in parameterList[constant("AppBundle\\Entity\\Parameter\\ParameterList::PARAMETER_GEARBOX")] %} {% set parameterListValue = parameterListValue ~ parameter.name ~ '|' %} {% endfor %} {{ parameterListValue[0:-1] }} |
reportNumber : {name} | Numérique | Nombre de rapports | |
color : {name} | Alphanumérique | Couleur |
Valeurs possibles de base : {% set parameterListValue = '' %} {% for parameter in parameterList[constant("AppBundle\\Entity\\Parameter\\ParameterList::PARAMETER_COLOR")] %} {% set parameterListValue = parameterListValue ~ parameter.name ~ '|' %} {% endfor %} {{ parameterListValue[0:-1] }} |
colorAccuracy : {name} | Alphanumérique | Précision couleur | Voir table de correspondance |
insideColor : {name} | Alphanumérique | Couleur intérieure |
Valeurs possibles de base : {% set parameterListValue = '' %} {% for parameter in parameterList[constant("AppBundle\\Entity\\Parameter\\ParameterList::PARAMETER_INSIDE_COLOR")] %} {% set parameterListValue = parameterListValue ~ parameter.name ~ '|' %} {% endfor %} {{ parameterListValue[0:-1] }} |
pricePublicWithoutTax | Numérique | Prix grand public HT | |
pricePublic | Numérique | Prix grand public TTC | |
priceSeller | Numérique | Prix négociant TTC | |
priceSellerWithoutTax | Numérique | Prix négociant HT | |
priceWeb | Numérique | Prix promo TTC | |
estimateCost | Numérique | Frais estimés HT | |
company: {siretNumber, phoneNumber, cellPhoneNumber} | Alphanumérique | Informations de la société : (SIRET, N° de téléphone, N° de téléphone portable) | |
warrantyType | Alphanumérique | Type de garantie | Voir table de correspondance |
warrantyOrganization | Alphanumérique | Organisme de garantie | |
warrantyLabel | Alphanumérique | Libellé de garantie | |
warrantyKilometric | Numérique | Km compris | |
warrantyDuration | Numérique | Durée de la garantie (en mois) | |
warrantyEndDate | Date | Date de fin de la garantie | |
supplier | Tableau « clé-valeur ». Clé : Alphabétique. Valeur : Alphanumérique. |
Fournisseur du véhicule |
|
expertise | Tableau « clé-valeur ». Clé : Alphabétique. Valeur : Alphanumérique. |
Expertise du véhicule |
|
dateOfDistribution | Date | Date de mise en circulation du véhicule | |
year | Date (format année) | Année du véhicule | |
distanceTraveled | Numérique | Kms du véhicule | |
distanceTraveledWarranty | Booléen | Garantie Kms du véhicule | |
gallery | Tableau « clé-valeur ». Clé :Alphabétique. Valeur: Alphanumérique | Photos des véhicules (url des images) |
|
availableDate | Date | Date de disponibilité du véhicule | |
entryStockDate | Date | Date d'entrée en arrivage du véhicule | |
entryFleetDate | Date | Date d'entrée parc du véhicule | |
origin | Alphanumérique | Provenance du véhicule | |
fleet | Alphanumérique | Parc du véhicule | |
coteDate | Date | Date de la côte | |
valueAverage | Numérique | Cours Moyen | |
valueMec | Numérique | Répercussion de la MEC | |
valueKm | Numérique | Répercussion du Kilométrage | |
valueCote | Numérique | Côte du véhicule | |
valueOption | Numérique | Répercussion des Options | |
valueNew | Numérique | Valeur à neuf sans option | |
valueNewOption | Numérique | Valeur à neuf avec option | |
note: | Alphanumérique | Remarques sur le véhicule | |
gender: {name} | Alphanumérique | Genre du véhicule |
Valeurs possibles de base : {% set parameterListValue = '' %} {% for parameter in parameterList[constant("AppBundle\\Entity\\Parameter\\ParameterList::PARAMETER_GENDER")] %} {% set parameterListValue = parameterListValue ~ parameter.name ~ '|' %} {% endfor %} {{ parameterListValue[0:-1] }} |
seatMaterial: {name} | Alphanumérique | Sellerie du véhicule |
Valeurs possibles de base : {% set parameterListValue = '' %} {% for parameter in parameterList[constant("AppBundle\\Entity\\Parameter\\ParameterList::PARAMETER_SEAT_MATERIAL")] %} {% set parameterListValue = parameterListValue ~ parameter.name ~ '|' %} {% endfor %} {{ parameterListValue[0:-1] }} |
segment: {name} | Alphanumérique | Segment du véhicule |
Valeurs possibles de base : {% set parameterListValue = '' %} {% for parameter in parameterList[constant("AppBundle\\Entity\\Parameter\\ParameterList::PARAMETER_SEGMENT")] %} {% set parameterListValue = parameterListValue ~ parameter.name ~ '|' %} {% endfor %} {{ parameterListValue[0:-1] }} |
taxHorsepower | Numérique | Puissance fiscale du véhicule | |
horsePower | Numérique | Puissance DIN du véhicule | |
carEngine | Numérique | Cylindrée | |
doors | Numérique | Nombre de portes du véhicule | |
seats | Numérique | Nombre de places du véhicule | |
urbanConsumption | Numérique | Conso. urbaine du véhicule | |
extraUrbanConsumption | Numérique | Conso. extra-urbaine du véhicule | |
mixteConsumption | Numérique | Conso. mixte du véhicule | |
extraUrbanKmConsumption | Numérique | Rejet extra-urbain du véhicule | |
isWorkshop | Booléen | Véhicule en atelier ? | |
isRental | Booléen | Véhicule en location ? | |
isRecoverableVat | Booléen | TVA récupérable ? | |
equipmentStandard | Tableau « clé-valeur ». Clé : Alphabétique. Valeur : Alphanumérique. |
Equipements de série du véhicule |
|
equipmentOptional | Tableau « clé-valeur ». Clé : Alphabétique. Valeur : Alphanumérique. |
Equipements en option du véhicule |
|
Vous trouverez la liste des correspondances des champs ci-dessous :
Code | Etat | Commentaires | Publier ? (Recommandation) |
---|---|---|---|
vehicle.state.pending | En cours | Véhicule en cours de saisie | Non |
vehicle.state.on_arrival | En arrivage | Véhicule neuf (VN) ou VO pas encore sur le PARC | Oui |
vehicle.state.parc | Parc | Véhicule physiquement sur PARC avec n° de VO | Oui |
vehicle.state.sold | Vendu | Véhicule avec Bon de commande (BC) validé | Non (ou Oui en précisant "vehicule VENDU") |
vehicle.state.sold_ar | Vendu AR | Véhicule En Arrivage avec Bon de commande (BC) validé | Non (ou Oui en précisant "vehicule VENDU") |
vehicle.state.out | Sorti | Véhicule vendu et sorti du parc | Non |
vehicle.state.out_ar | Sorti AR | Véhicule vendu sans passer par le parc | Non |
vehicle.state.canceled | Annulé | Véhicule restitué | Non |
vehicle.state.workshop | TOUT-VENANT ATELIER | Véhicule tout-venant pour l'atelier non destiné à la vente | Non |
Code | Valeur |
---|---|
{{ key }} | {{ colorAccuracy }} |
Code | Valeur |
---|---|
{{ key }} | {{ warrantyType }} |
Code | Pays | {% endfor %}
---|---|
{{ code }} | {{ country }} | {% endfor %}
L’API REST renvoie directement dans la réponse au format JSON les erreurs qui pourraient survenir. Voici ci-dessous un exemple de format :
{
"code": 400,
"message": "Bad Request"
}
Ce changelog référence les changements faites dans la version {{ currentApiVersion }}
Variables ajoutées | |
---|---|
Ajout de la variable nbPageList | Voir le détail |
Ajout de la variable supplier | Voir le détail |
Ajout de la variable expertise | Voir le détail |