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: http://demo.kepler-soft.net/api/
L’accès aux services KEPLER SOFT est géré par une clé API qui doit être fournie à chaque requête: http://demo.kepler-soft.net/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 : « v2.4 » |
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 http://demo.kepler-soft.net/api/{version}/api-key/{apiKey}/vehicles/
Exemple: http://demo.kepler-soft.net/api/{version}/api-key/{apiKey}/vehicles/?page=1&count=10&orderBy%5bbrand%5d=DESC&dateUpdatedStart=2016-01-01
La méthode est limitée à 100 appels/heure. SI le quota est dépassé, un code erreur 400 sera retourné.
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: {version} |
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 spécifique. 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 spécifiques. Si vous désirez plusieurs états, concaténez les états désirés par une ",". Ce paramètre est optionnel. |
Voir détail |
reference | Alphanumérique | Filtre sur la référence du véhicule désiré. La référence est unique par véhicule. En passant ce paramètre, vous pouvez récupérer seulement le véhicule de la référence définie. 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 spécifique. Ce paramètre est optionnel. |
Voir détail |
licenseeNumber | Alphanumérique | Filtre sur l'immatriculation des véhicules désirés. En passant ce paramètre, vous pouvez récupérer seulement les véhicules d’une immatriculation spécifique. 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 spécifique. 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 spécifique. 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 spécifique. 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é spécifique. 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 : 0KM|VN|VO |
vehicleType | Alphabétique | Type du véhicule (Véhicule particulier, Véhicule utilitaire, Véhicule 4 roues motrices) |
Valeurs possibles de base : 4WD|PL|VP|VU |
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 : Courant électrique|Diesel|Diesel / Courant électrique|Diesel ou gaz|Electric|Electrique|Ess+g.p.l.|Essence|Essence / Courant électrique|Essence / Ethanol|Essence / Ethanol / Courant electrique|Essence ou gaz|Essence plomb|Essence sans plomb|GNV|Hydrogène |
firstHand | Booléen | Première main | |
bodywork : {name} | Alphanumérique | Carrosserie du véhicule |
Valeurs possibles de base : 4X4|Autres|Benne|Benne-Double-Cabine|Berline|Break|Cabine|Cabriolet|Camion|Camionette|Châssis|Châssis cabine|Châssis cabine double|Chassis-Double Cabine|Chassis-nu|Combi I|Combin|Combiné|Combispace|Coup|Coupé|Crossover-suv|Fourgon|Fourgon sureleve|Fourgon vitré|Fourgonnette|Hard-Top|Limousine|Ludospace|Mini Bus|Minibus|Minispace|Monospace|Monospace compact|Multispace|Pick-Up|Pick-Up (VP)|Pick-Up acier|Pick-up cabine double|Pick-Up Hardtop|Pick-Up long|Pick-Up-Double-Cabine|Plancher-Cabine|Plateau|Plateau cabine|Plateau ridelle|Plateau-Double Cabine|Plateau-Ridelles-Double-C|Roadster|Spider|Targa|Tout-Terrain|Tout-Terrain Cabrio|Tout-Terrain Long|Ts terrains/chemins|Utilitaire|Utilitaires |
gearbox : {name} | Alphanumérique | Boîte |
Valeurs possibles de base : Automate à fonct. Continu|Automate à fonct.continu,sequ.|Automate sequentiel|Automatique|B.v.a.|Bo|Boîte automatique|Boîte automatisée|Boîte avec groupe(s)|Boîte manuelle|Boîte séquentielle|Manuelle|Mecanique|Sans boite de vitesse |
reportNumber : {name} | Numérique | Nombre de rapports | |
color : {name} | Alphanumérique | Couleur |
Valeurs possibles de base : Beige|Beige Clair|Beige Foncé|Blanc|Blanc fonce|Bleu|Bleu Clair|Bleu Foncé|Bordeaux|Gris|Gris Clair|Gris Foncé|Gris-argent|Inc.|Inconnu|Jaune|Jaune Clair|Jaune Foncé|Marron|Marron Clair|Marron Foncé|Noir|Noir clair|Orange|Orange Clair|Rouge|Rouge Clair|Rouge Foncé|Vert|Vert Clair|Vert Foncé|Violet |
colorAccuracy : {name} | Alphanumérique | Précision couleur | Voir table de correspondance |
insideColor : {name} | Alphanumérique | Couleur intérieure |
Valeurs possibles de base : Beige|Gris|Noir |
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 : 4WD|CAM|CTTE|PL|VP|VU |
seatMaterial: {name} | Alphanumérique | Sellerie du véhicule |
Valeurs possibles de base : Alcantara|Cuir|Semi cuir|Tissu|Velours |
segment: {name} | Alphanumérique | Segment du véhicule |
Valeurs possibles de base : 4X4|4x4, SUV et Crossover|Breaks|Cabriolets|Citadines|Coupés|Grandes berlines|Monospaces|Moyennes berlines|Utilitaires |
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 |
|
location | Alphanumérique | Emplacement du véhicule | |
situation | Alphanumérique | Situation 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 |
---|---|
vehicle.color_accuracy.glossy | Laqué |
vehicle.color_accuracy.matte | Mat |
vehicle.color_accuracy.metallic | Métallisé |
vehicle.color_accuracy.pearl | Nacré |
vehicle.color_accuracy.varnish | Verni |
Code | Valeur |
---|---|
vehicle.warranty.type.with | Garantie |
vehicle.warranty.type.manufacturer | Garantie constructeur |
vehicle.warranty.type.without | Sans garantie |
Code | Pays | Code | Pays | Code | Pays | Code | Pays | Code | Pays | Code | Pays |
---|---|---|---|---|---|---|---|---|---|---|---|
AF | Afghanistan | ZA | Afrique du Sud | AL | Albanie | DZ | Algérie | DE | Allemagne | AD | Andorre |
AO | Angola | AI | Anguilla | AQ | Antarctique | AG | Antigua-et-Barbuda | SA | Arabie saoudite | AR | Argentine |
AM | Arménie | AW | Aruba | AU | Australie | AT | Autriche | AZ | Azerbaïdjan | BS | Bahamas |
BH | Bahreïn | BD | Bangladesh | BB | Barbade | BE | Belgique | BZ | Belize | BJ | Bénin |
BM | Bermudes | BT | Bhoutan | BY | Biélorussie | BO | Bolivie | BA | Bosnie-Herzégovine | BW | Botswana |
BR | Brésil | BN | Brunéi Darussalam | BG | Bulgarie | BF | Burkina Faso | BI | Burundi | KH | Cambodge |
CM | Cameroun | CA | Canada | CV | Cap-Vert | EA | Ceuta et Melilla | CL | Chili | CN | Chine |
CY | Chypre | CO | Colombie | KM | Comores | CG | Congo-Brazzaville | CD | Congo-Kinshasa | KP | Corée du Nord |
KR | Corée du Sud | CR | Costa Rica | CI | Côte d’Ivoire | HR | Croatie | CU | Cuba | CW | Curaçao |
DK | Danemark | DG | Diego Garcia | DJ | Djibouti | DM | Dominique | EG | Égypte | AE | Émirats arabes unis |
EC | Équateur | ER | Érythrée | ES | Espagne | EE | Estonie | VA | État de la Cité du Vatican | FM | États fédérés de Micronésie |
US | États-Unis | ET | Éthiopie | FJ | Fidji | FI | Finlande | FR | France | GA | Gabon |
GM | Gambie | GE | Géorgie | GS | Géorgie du Sud et îles Sandwich du Sud | GH | Ghana | GI | Gibraltar | GR | Grèce |
GD | Grenade | GL | Groenland | GP | Guadeloupe | GU | Guam | GT | Guatemala | GG | Guernesey |
GN | Guinée | GQ | Guinée équatoriale | GW | Guinée-Bissau | GY | Guyana | GF | Guyane française | HT | Haïti |
HN | Honduras | HU | Hongrie | CX | Île Christmas | AC | Île de l’Ascension | IM | Île de Man | NF | Île Norfolk |
AX | Îles Åland | KY | Îles Caïmans | IC | Îles Canaries | CC | Îles Cocos | CK | Îles Cook | FO | Îles Féroé |
FK | Îles Malouines | MP | Îles Mariannes du Nord | MH | Îles Marshall | UM | Îles mineures éloignées des États-Unis | PN | Îles Pitcairn | SB | Îles Salomon |
TC | Îles Turques-et-Caïques | VG | Îles Vierges britanniques | VI | Îles Vierges des États-Unis | IN | Inde | ID | Indonésie | IQ | Irak |
IR | Iran | IE | Irlande | IS | Islande | IL | Israël | IT | Italie | JM | Jamaïque |
JP | Japon | JE | Jersey | JO | Jordanie | KZ | Kazakhstan | KE | Kenya | KG | Kirghizistan |
KI | Kiribati | XK | Kosovo | KW | Koweït | RE | La Réunion | LA | Laos | LS | Lesotho |
LV | Lettonie | LB | Liban | LR | Libéria | LY | Libye | LI | Liechtenstein | LT | Lituanie |
LU | Luxembourg | MK | Macédoine | MG | Madagascar | MY | Malaisie | MW | Malawi | MV | Maldives |
ML | Mali | MT | Malte | MA | Maroc | MQ | Martinique | MU | Maurice | MR | Mauritanie |
YT | Mayotte | MX | Mexique | MD | Moldavie | MC | Monaco | MN | Mongolie | ME | Monténégro |
MS | Montserrat | MZ | Mozambique | MM | Myanmar (Birmanie) | NA | Namibie | UN | Nations Unies | NR | Nauru |
NP | Népal | NI | Nicaragua | NE | Niger | NG | Nigéria | NU | Niue | NO | Norvège |
NC | Nouvelle-Calédonie | NZ | Nouvelle-Zélande | OM | Oman | UG | Ouganda | UZ | Ouzbékistan | PK | Pakistan |
PW | Palaos | PA | Panama | PG | Papouasie-Nouvelle-Guinée | PY | Paraguay | NL | Pays-Bas | BQ | Pays-Bas caribéens |
PE | Pérou | PH | Philippines | PL | Pologne | PF | Polynésie française | PR | Porto Rico | PT | Portugal |
QA | Qatar | HK | R.A.S. chinoise de Hong Kong | MO | R.A.S. chinoise de Macao | CF | République centrafricaine | DO | République dominicaine | RO | Roumanie |
GB | Royaume-Uni | RU | Russie | RW | Rwanda | EH | Sahara occidental | BL | Saint-Barthélemy | KN | Saint-Christophe-et-Niévès |
SM | Saint-Marin | MF | Saint-Martin | SX | Saint-Martin (partie néerlandaise) | PM | Saint-Pierre-et-Miquelon | VC | Saint-Vincent-et-les-Grenadines | SH | Sainte-Hélène |
LC | Sainte-Lucie | SV | Salvador | WS | Samoa | AS | Samoa américaines | ST | Sao Tomé-et-Principe | SN | Sénégal |
RS | Serbie | SC | Seychelles | SL | Sierra Leone | SG | Singapour | SK | Slovaquie | SI | Slovénie |
SO | Somalie | SD | Soudan | SS | Soudan du Sud | LK | Sri Lanka | SE | Suède | CH | Suisse |
SR | Suriname | SJ | Svalbard et Jan Mayen | SZ | Swaziland | SY | Syrie | TJ | Tadjikistan | TW | Taïwan |
TZ | Tanzanie | TD | Tchad | CZ | Tchéquie | TF | Terres australes françaises | IO | Territoire britannique de l’océan Indien | PS | Territoires palestiniens |
TH | Thaïlande | TL | Timor oriental | TG | Togo | TK | Tokélaou | TO | Tonga | TT | Trinité-et-Tobago |
TA | Tristan da Cunha | TN | Tunisie | TM | Turkménistan | TR | Turquie | TV | Tuvalu | UA | Ukraine |
UY | Uruguay | VU | Vanuatu | VE | Venezuela | VN | Vietnam | WF | Wallis-et-Futuna | YE | Yémen |
ZM | Zambie | ZW | Zimbabwe | EZ | zone euro |
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 v2.4
Variables modifiées | |
---|---|
Modification de la variable equipmentStandard | Voir le détail |
Modification de la variable equipmentOptional | Voir le détail |