API dokumentáció
Utolsó módosítás: 2019.06.26
Az autotveszek.hu egy ún. REST API-t biztosít a kereskedők számára, mely segítségével a hirdetések feltöltése és kezelése automatizálható. Ezt az automatizmust úgy kell elképzelni, hogy a jelenleg használt szoftverbe (mely lehet bármi, egy belső nyilvántartás, vállalatirányítási,- hirdetés nyilvántartási rendszer, CRM stb.) az API segítségével integrálható az autotveszek.hu hirdetéskezelése. A programnyelv és a platform független, mert az API teljesen szabványos utasításokat használ.
Az integráció két irányú, azaz lehetőség van az autotveszek.hu-n lévő hirdetéskezelés automatizálására, valamint lehetőség van a fordított esetre is, azaz a hirdetések autotveszek.hu-ról való szinkronizálására is, íly módon az autotveszek.hu -ra feltöltött hirdetések személyre szabott nézetben megjeleníthetők saját weboldalon is.
Tipikus integráció, hogy a kereskedés már rendelkezik egy belső nyilvántartó rendszerrel, ahol folyamatosan rögzítik a gépjárműveket. A hirdetések egyenként történő kézi feltöltése az autotveszek.hu -ra főként nagy mennyiségben körülményes és időigényes lenne, de az API integrációját követően ezek a nyilvántartásba rögzített gépjárművek, hirdetés formájában automatikusan létrejöhetnek az autitveszek.hu -n.
Emellett közkedvelt funkció az is, ha a kereskedésnek van önállóan is weboldala melyen a hirdetéseket szeretnék megjeleníteni. Ekkor sem kell dupla adatföltéssel foglalkozni, mert az autotveszek.hu -ra feltöltött hirdetések folyamatosan leszinkronizálhatóak a kereskedés saját weboldalára, mi több ott tetszőleges formában meg is jeleníthetőek, így a kereskedés saját weboldalának arculatán mutatkozhat minden.
API HASZNÁLAT ÉS INTEGRÁCIÓ FELTÉTELEI
1.) Érvényes autotveszek.hu regisztráció
2.) Aktív API kulcs
3.) Informatikus, vagy fejlesztő kapcsolat aki végrehajtja a szoftver integrációt
API KULCS KEZELÉSE
A PROFILOM oldalon a "Profilom és névjegykártyám módosítása" szekcióban megtalálhatod az API hozzáférés beállításait. Az "Új API kulcs" gomb megnyomásával azonnal elkészül az API kulcsod, melyet a rendszer az email címedre küld el. Fontos, hogy a kulcs ne jusson illetéktelen személyek kezébe, mert a kulcs birtokában API-n keresztül bárki, bárhonnan teljes jogkörrel kezelheti a hirdetéseidet!
Az API kulcs megőrzése fontos, mert a rendszer nem tud API kulcs ismétlést küldeni, az elveszett API kulcs az "Új API kulcs" ismételt megnyomásával újragenerálható. Ha az API -ra nincs szükséged, akkor az "API hozzáférés tiltása" opcióval törölheted!
API ERŐFORRÁSOK ÉS METÓDUSOK
Az autotveszek.hu erőforrásai HTTP-n keresztül érhetők el, a https://autotveszek.hu/api URL cím alatt. Az API a JSON-t használja csereformátumként.
Összes gépjármű márka listázása
Az autotveszek.hu adatbázisa tartalmazza a világban használt összes gépjármű márkát. A rendszerben a márkák azonosításához márka azonosítót (ID-t) használunk, ezért szükséges, hogy a márkák listázhatók legyenek, ezáltal megismerjük a kívánt márka ID-jét mellyel a többi erőforrás alatt hivatkozunk majd rá.
A márkák listázásához a https://autotveszek.hu/api/makes erőforrást POST metódussal kell használjuk, meghívásakor az alábbi mezők megadása lehetséges:
Válaszban kapott adatmezők:
Minta lekérdezés cURL segítségével:
Válaszban kapott adatmezők:
Minta lekérdezés cURL segítségével - összes Jaguar (ID: 3) modell:
Válaszban kapott adatmezők:
Minta lekérdezés cURL segítségével - összes Jaguar (ID: 3) E-Pace (ID: 2259) modell generációinak lekérdezése:
Minta lekérdezés cURL segítségével:
Válaszban kapott adatmezők:
Minta lekérdezés cURL segítségével:
Válaszban kapott adatmezők:
Minta lekérdezés cURL segítségével:
A válaszban kapott adatmezők megegyeznek az előző,- /view erőforrásban használtéval, kiegészítve azt néhány további,- többnyire gyártó specifikus mezővel.
Minta lekérdezés cURL segítségével:
Válaszban kapott adatmezők:
Minta létrehozás cURL segítségével - Jaguar E-Pace 2.0d (180 LE) AWD Automatic 2018:
Válaszban kapott adatmezők:
Minta módosítás cURL segítségével:
Válaszban kapott adatmezők:
Minta feltöltés cURL segítségével:
FUNKCIÓ | ERŐFORRÁS | HTTP METÓDUS |
---|---|---|
Összes gépjármű márka listázása | /makes | POST |
Márka alatti gépjármű modellek listázása | /models | POST |
Modell alatti gépjármű generációk listázása | /generations | POST |
Használható hirdetés opciók és extrák listázása | /options | POST |
Hirdetéseim listázása | /advertisements | POST |
Kiválasztott hirdetés teljes megtekintése (szöveges) | POST | |
Kiválasztott hirdetés megtekintése (ID-kkel) | /view | POST |
Új hirdetés felvétele | /create | POST |
Hirdetés módosítása | /update | POST |
Hirdetéshez képek feltöltése | /images | POST |
NÉV | TÍPUS | KÖTELEZŐ | LEÍRÁS |
---|---|---|---|
apikey | szöveg | igen | Saját API kulcs |
subscription | szöveg | igen | Előfizetés azonosító |
NÉV | TÍPUS | LEÍRÁS |
---|---|---|
make | egész szám | Márka egyedi azonosítója |
make_name | szöveg | Márka természetes neve |
curl -X POST \ https://autotveszek.hu/api/makes \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ "apikey" : "f151ad38-53fd-4d60-b388-2132883ac7c8", "subscription": "87BA65C4F505C4F3" }'Minta lekérdezés válasza:
{ "makes": [ ... { "make": "3", "make_name": "Jaguar" }, { "make": "4", "make_name": "Nissan" }, ... ] }Márka alatti gépjármű modellek listázása Az autotveszek.hu adatbázisa tartalmazza a világban használt összes gépjármű márkát és modellt. Az előbb megismert márkákhoz hasonlóan a modellek azonosításához és hivatkozásához szintén azonosítót (ID-t) használunk. A modellek listázásához a https://autotveszek.hu/api/models erőforrást POST metódussal kell használjuk, meghívásakor az alábbi mezők megadása lehetséges:
NÉV | TÍPUS | KÖTELEZŐ | LEÍRÁS |
---|---|---|---|
apikey | szöveg | igen | Saját API kulcs |
subscription | szöveg | igen | Előfizetés azonosító |
make | egész szám | igen | Gépjármű márka ID-je |
NÉV | TÍPUS | LEÍRÁS |
---|---|---|
make | egész szám | Márka egyedi azonosítója |
model | egész szám | Modell egyedi azonosítója |
model_name | szöveg | Modell természetes neve |
curl -X POST \ https://autotveszek.hu/api/models \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ "apikey" : "f151ad38-53fd-4d60-b388-2132883ac7c8", "subscription": "87BA65C4F505C4F3", "make": "3" }'Minta lekérdezés válasza:
{ "models": [ ... { "make": "3", "model": "2104", "model_name": "F-Pace" }, { "make": "3", "model": "2259", "model_name": "E-Pace" }, ... ] }Modell alatti gépjármű generációk listázása Az autotveszek.hu adatbázisa tartalmazza a világban használt összes gépjármű márkát, modellt és azon belül generációkat. Az előbb megismert márkákhoz és modellekhez hasonlóan a generációk azonosításához és hivatkozásához szintén azonosítót (ID-t) használunk. A generációk listázásához a https://autotveszek.hu/api/generations erőforrást POST metódussal kell használjuk, meghívásakor az alábbi mezők megadása lehetséges:
NÉV | TÍPUS | KÖTELEZŐ | LEÍRÁS |
---|---|---|---|
apikey | szöveg | igen | Saját API kulcs |
subscription | szöveg | igen | Előfizetés azonosító |
make | egész szám | igen | Gépjármű márka ID-je |
model | egész szám | igen | Gépjármű modell ID-je |
NÉV | TÍPUS | LEÍRÁS |
---|---|---|
make | egész szám | Márka egyedi azonosítója |
model | egész szám | Modell egyedi azonosítója |
generation | egész szám | Generáció egyedi azonosítója |
make_name | szöveg | Márka természetes neve |
model_name | szöveg | Modell természetes neve |
generation_name | szöveg | Generáció természetes neve |
engine_name | szöveg | Bővített név motor megnevezéssel |
production_from | egész szám | Gyártás kezdő éve |
curl -X POST \ https://autotveszek.hu/api/generations \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ "apikey" : "f151ad38-53fd-4d60-b388-2132883ac7c8", "subscription": "87BA65C4F505C4F3", "make": "3", "model": "2259" }'Minta lekérdezés válasza:
{ "generations": [ ... { "make": "3", "model": "2259", "generation": "30582", "make_name": "Jaguar", "model_name": "E-Pace", "generation_name": "E-Pace", "engine_name": "2.0d (150 Hp) AWD Automatic", "production_from": "2018" }, { "make": "3", "model": "2259", "generation": "30657", "make_name": "Jaguar", "model_name": "E-Pace", "generation_name": "E-Pace", "engine_name": "2.0d (180 Hp) AWD Automatic", "production_from": "2018" }, ... ] }Használható hirdetés opciók és extrák listázása Az autotveszek.hu rendszerében több mint 150 hirdetésekben használható opció érhető el, melyek a hirdetés jellemzőit illetve a hirdetésben szereplő gépjármű paramétereit (pl. extrák, dokumentációk stb.) tartalmazzák. Minden ilyen opció saját azonosítóval (ID) rendelkezik, mely azonosítóval tudunk rájuk hivatkozni a többi erőforrásban. Az elérhető opciók listázásához a https://autotveszek.hu/api/options erőforrást POST metódussal kell használjuk, meghívásakor az alábbi mezők megadása lehetséges:
NÉV | TÍPUS | KÖTELEZŐ | LEÍRÁS |
---|---|---|---|
apikey | szöveg | igen | Saját API kulcs |
subscription | szöveg | igen | Előfizetés azonosító |
locale | szöveg | igen | Megjelenítés nyelv azonosítója (magyar: "hu") |
curl -X POST \ https://autotveszek.hu/api/options \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ "apikey" : "f151ad38-53fd-4d60-b388-2132883ac7c8", "subscription": "87BA65C4F505C4F3", "locale": "hu" }'Minta lekérdezés válasza:
{ ... "19": "Elektromos hátsóülés állítás", "20": "Elektromos külső tükrök", "21": "Headup (Vetített kijelző)", "22": "Integrált zene streaming", "23": "Deréktámasz", "24": "Fedélzeti számítógép", ... }Hirdetéseim listázása Az összes előfizetésbe tartozó hirdetés listázásához a https://autotveszek.hu/api/advertisements erőforrást POST metódussal kell használjuk, meghívásakor az alábbi mezők megadása lehetséges:
NÉV | TÍPUS | KÖTELEZŐ | LEÍRÁS |
---|---|---|---|
apikey | szöveg | igen | Saját API kulcs |
subscription | szöveg | igen | Előfizetés azonosító |
NÉV | TÍPUS | LEÍRÁS |
---|---|---|
ad_id | szöveg | Egyedi hirdetés azonosító |
modified | dátum | Hirdetés utolsó módosításának ideje |
position | egész szám | Hirdetés pozíciója (1: aktív, 2: eladva, 3: törölve) |
curl -X POST \ https://autotveszek.hu/api/options \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ "apikey" : "f151ad38-53fd-4d60-b388-2132883ac7c8", "subscription": "87BA65C4F505C4F3", }'Minta lekérdezés válasza:
{ "advertisements": [ { "ad_id": "0F26A659C8DEABCA", "modified": "2018-10-31 16:38:30", "position": "3" }, { "ad_id": "7B3CEACFBC142B06", "modified": "2018-10-31 20:36:49", "position": "1" }, { "ad_id": "EDA19FBCF2941EAC", "modified": "2018-11-03 14:43:54", "position": "1" } ] }Kiválasztott hirdetés megtekintése (ID-kkel) Kiválasztott hirdetés adatainak megtekintéséhez a https://autotveszek.hu/api/view erőforrást POST metódussal kell használjuk, meghívásakor az alábbi mezők megadása lehetséges:
NÉV | TÍPUS | KÖTELEZŐ | LEÍRÁS |
---|---|---|---|
apikey | szöveg | igen | Saját API kulcs |
subscription | szöveg | igen | Előfizetés azonosító |
ad_id | szöveg | igen | Hirdetés azonosító |
NÉV | TÍPUS | LEÍRÁS |
---|---|---|
ad_id | szöveg | Hirdetés azonosító |
modified | dátum | Hirdetés utolsó módosításának ideje |
make | egész szám | Márka azonosító |
model | egész szám | Modell azonosító |
generation | egész szám | Generáció azonosító |
condition | egész szám | Gépjármű kondíció azonosító (1: használt, 2: új gépjármű) |
draft | egész szám | Hirdetés piszkozat (1: nem piszkozat, 2: piszkozat - rejtett) |
price | egész szám | Feltüntetett ár HUF -ban |
tax | egész szám | Árhoz tartozó ÁFA beállítás (0: nem ÁFÁ-s, 1: ÁFÁ-s) |
status | egész szám | Gépjármű állapota (1: normál, 2: újszerű, 3: enyhén sérült, 4: törött, 5: hiányos) |
position | egész szám | Hirdetés pozíciója (1: aktív, 2: eladva, 3: törölve) |
year | egész szám | Forgalomba helyezés évjárata |
km | egész szám | Futott kilométer |
inspection_year | egész szám | Műszaki vizsga érvényesség éve |
inspection_month | egész szám | Műszaki vizsga érvényesség hónapja |
vin | szöveg | Alvázszám |
color_exterior | szöveg | Külső szín angolul (beige, black, blue, brown, gold, green, grey, orange, purple, red, silver, white, yellow, claret, 0: nincs megadva) |
color_exterior_2 | szöveg | Második külső szín angolul (beige, black, blue, brown, gold, green, grey, orange, purple, red, silver, white, yellow, claret, 0: nincs megadva) |
color_interior | szöveg | Beltér szín angolul (beige, black, blue, brown, gold, green, grey, orange, purple, red, silver, white, yellow, claret, 0: nincs megadva) |
color_interior_2 | szöveg | Második beltér szín angolul (beige, black, blue, brown, gold, green, grey, orange, purple, red, silver, white, yellow, claret, 0: nincs megadva) |
color_metallic | egész szám | Metálfényezés azonosító (0: nem, 1: igen) |
color_pearl | egész szám | Gyöngyház fényezés azonosító (0: nem, 1: igen) |
cylinder_ccm | egész szám | Lökettérfogat cm3 -ben |
cylinder_position | szöveg | Henger pozíciója (inline: soros, v: V elrendezés, w: W elrendezés, wankel: Wankel motor) |
cylinder_count | egész szám | Hengerek száma |
body | szöveg | Gépjármű kivitel (cabriolet: Kabrió, combi: Kombi, mpv: Egyterű, coupe: Kupé, crossover: Városi terepjáró, hatchback: Ferdehátú, suv: SUV, sedan: Szedán, pickup: Pick-up) |
fuel | szöveg | Üzemanyag típusa (diesel: Gázolaj, electricity: Elektromos, hydrogen: Hidrogén, petrol: Benzin, petrol_cng: CNG-benzin, petrol_ethanol:Etanol-benzin, petrol_lpg: LPG-benzin, hybrid_diesel: Hibrid-dízel, hybrid_petrol: Hibrid-benzines) |
power | egész szám | Motor teljesítménye (LE) |
torque | egész szám | Forgatónyomaték (Nm) |
drive | szöveg | Hajtás (front: Első kerék, rear: Hátsó kerék, all: Összkerék) |
transmission | egész szám | Váltó típus azonosító (0: Manuális, 1: Automata) |
gears | egész szám | Sebességek száma |
doors | egész szám | Ajtók száma |
seats | egész szám | Szállítható személyek száma |
description | szöveg | Hirdetéshez tartozó szabadszavas leírás |
options | tömb | Hirdetésben használt hirdetés opciók és extrák azonosítói. Az első szám a sorszámot jelöli, de a hirdetés megjelenítése szempontjából nem releváns. |
images | tömb | Hirdetésben használt képek, azok megjelenítési sorrendjében. |
subscription | szöveg | Előfizetés azonosító |
curl -X POST \ https://autotveszek.hu/api/view \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ "apikey" : "f151ad38-53fd-4d60-b388-2132883ac7c8", "ad_id" : "EDA19FBCF2941EAC", "subscription": "87BA65C4F505C4F3", }'Minta lekérdezés válasza:
{ "ad_id": "EDA19FBCF2941EAC", "modified": "2018-11-03 14:43:54", "make": "11", "model": "177", "generation": "28872", "condition": "1", "draft": "1", "price": "8970000", "tax": "1", "status": "1", "position": "1", "year": "2012", "km": "12500", "inspection_year": "2019", "inspection_month": "11", "vin": "ABC12345", "color_exterior": "red", "color_exterior_2": "0", "color_interior": "black", "color_interior_2": "grey", "color_metallic": "1", "color_pearl": "0", "cylinder_ccm": "1995", "cylinder_position": "inline", "cylinder_count": "4", "body": "sedan", "fuel": "petrol", "power": "510", "torque": "250", "drive": "front", "transmission": "0", "gears": "8", "doors": "3", "seats": "4", "description": "Frissen szervizelt, nagyon #megkimelt állapotban.", "options": { "0": "1", "1": "8", "2": "12", "3": "13" }, "subscription": "87BA65C4F505C4F3", "images": [ { "original_url": "https://autotveszek.hu/userfiles/files/E/EDA19FBCF2941EAC_5bdee08371019.jpeg", "thumbnail_url": "https://autotveszek.hu/userfiles/files/E/thumbnail/EDA19FBCF2941EAC_5bdee08371019.jpeg" }, { "original_url": "https://autotveszek.huuserfiles/files/E/EDA19FBCF2941EAC_5bdee083e4055.jpeg", "thumbnail_url": "https://autotveszek.hu/userfiles/files/E/thumbnail/EDA19FBCF2941EAC_5bdee083e4055.jpeg" }, { "original_url": "https://autotveszek.hu/userfiles/files/E/EDA19FBCF2941EAC_5bdee0846993a.jpeg", "thumbnail_url": "https://autotveszek.hu/userfiles/files/E/thumbnail/EDA19FBCF2941EAC_5bdee0846993a.jpeg" } ] }Kiválasztott hirdetés teljes megtekintése (szöveges) A hirdetések megtekintése az előbb megismert mód mellett lehetséges kiterjesztett,- szöveges formában is. Ez leginkább a saját hirdetéseink weboldalunkon történő elhelyezésekor lehet hasznos, mert az ID-k helyett "lefordított" szövegek vannak. A hirdetés ilyen módon történő megtekintéséhez a https://autotveszek.hu/api/print erőforrást POST metódussal kell használjuk, meghívásakor az alábbi mezők megadása lehetséges:
NÉV | TÍPUS | KÖTELEZŐ | LEÍRÁS |
---|---|---|---|
apikey | szöveg | igen | Saját API kulcs |
subscription | szöveg | igen | Előfizetés azonosító |
ad_id | szöveg | igen | Hirdetés azonosító |
locale | szöveg | igen | Megjelenítés nyelv azonosítója (magyar: "hu") |
curl -X POST \ https://autotveszek.hu/api/makes \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ "apikey" : "f151ad38-53fd-4d60-b388-2132883ac7c8", "ad_id" : "EDA19FBCF2941EAC", "subscription": "87BA65C4F505C4F3", "locale": "hu" }'Minta lekérdezés válasza:
{ "ad_id": "C680CBC94BAE5D5E", "position": "Aktív", "condition": "Használt", "draft": "Nincs megadva", "modified": "2018-11-04 14:54:22", "make": "Jaguar", "model": "E-Pace", "model_sub": "E-Pace", "generation": "2.0d (180 Hp) AWD Automatic", "generation_user": null, "url": "https://autotveszek.hu/details/jaguar-e-pace-20d-(180-hp)-awd-automatic--c680cbc94bae5d5e", "status": "Normál", "vin": "ABC12345", "year": "2012", "price": "18970000", "tax": "ÁFÁ-t tartalmazza", "km": "12500", "body": "Szedán", "doors": "3", "seats": "4", "kerb_weight": "1843", "max_weight": null, "width": "1984", "height": "1649", "length": "4395", "wheelbase": "2681", "turning_circle": null, "tank": "55.7", "trunk": "1234", "fuel": "Benzin", "co2": "147", "emission_standard": "EURO VI", "cylinder_position": "Soros", "cylinder_count": "4", "transmission": "Manuális", "gears": "8", "drive": "Első kerék", "cylinder_ccm": "1995", "consumption_city": "6.5", "consumption_highway": "5.1", "consumption_combined": "5.6", "max_speed": "205", "acceleration": "9.3", "torque": "250", "torque_rpm": "1750", "power": "510", "tyre_width": "225", "tyre_height": "65", "tyre_diameter": "17", "luggage_size": null, "battery_capacity": null, "electric_range": null, "electric_torque": null, "inspection_year": "2019", "inspection_month": "11", "color_exterior": "Piros", "color_exterior_2": "Ismeretlen", "color_interior": "Fekete", "color_interior_2": "Szürke", "color_metallic": "Metál", "color_pearl": null, "description": "Frissen szervizelt, nagyon #megkímélt állapotban.", "options": { "0": "Automata klíma", "1": "Digitális műszerfal", "2": "Navigációs rendszer (GPS)", "3": "Esőszenzor" }, "subscription": "87BA65C4F505C4F3", "images": [ { "original_url": "https://autotveszek.hu/userfiles/files/E/EDA19FBCF2941EAC_5bdee08371019.jpeg", "thumbnail_url": "https://autotveszek.hu/userfiles/files/E/thumbnail/EDA19FBCF2941EAC_5bdee08371019.jpeg" }, { "original_url": "https://autotveszek.huuserfiles/files/E/EDA19FBCF2941EAC_5bdee083e4055.jpeg", "thumbnail_url": "https://autotveszek.hu/userfiles/files/E/thumbnail/EDA19FBCF2941EAC_5bdee083e4055.jpeg" }, { "original_url": "https://autotveszek.hu/userfiles/files/E/EDA19FBCF2941EAC_5bdee0846993a.jpeg", "thumbnail_url": "https://autotveszek.hu/userfiles/files/E/thumbnail/EDA19FBCF2941EAC_5bdee0846993a.jpeg" } ] }Új hirdetés felvétele Az API-n keresztül történő hirdetés feladáshoz pontos márka, modell és generáció azonosításhoz van szükség, azaz a "szabad szavas" feladás az API-n keresztül nem lehetséges! A feladáskor a rendszer automatikusan megpróbálja kitölteni a típus-specifikus információkat, mint például a gépjármű teljesítménye, ajtók száma stb. Új hirdetés feladáshoz a https://autotveszek.hu/api/advertisements erőforrást POST metódussal kell használjuk, meghívásakor az alábbi mezők megadása lehetséges:
NÉV | TÍPUS | KÖTELEZŐ | LEÍRÁS |
---|---|---|---|
apikey | szöveg | igen | Saját API kulcs |
subscription | szöveg | igen | Előfizetés azonosító |
make | egész szám | igen | Márka azonosító |
model | egész szám | igen | Modell azonosító |
generation | egész szám | igen | Generáció azonosító (értéke 0 ha generation_user beállítva) |
generation_user | szöveg | opcionális | Generáció azonosító (szabadszavas, megadása kötelező ha generation értéke 0) |
price | egész szám | igen | Feltüntetett ár HUF -ban |
year | egész szám | igen | Forgalomba helyezés évjárata |
km | egész szám | nem | Futott kilométer (alapértelmezett: 0) |
tax | egész szám | nem | Árhoz tartozó ÁFA beállítás (0: nem ÁFÁ-s, 1: ÁFÁ-s) (alapértelmezett: 0) |
condition | egész szám | nem | Gépjármű kondíció azonosító (1: használt, 2: új gépjármű) (alapértelmezett: 1) |
draft | egész szám | nem | Hirdetés piszkozat (1: nem piszkozat, 2: piszkozat - rejtett) (alapértelmezett: 1) |
NÉV | TÍPUS | LEÍRÁS |
---|---|---|
ad_id | szöveg | Egyedi hirdetés azonosító, mellyel ezentúl hivatkozhatunk a hirdetésre |
message | szöveg | Sikeres létrehozás üzenete |
curl -X POST \ https://autotveszek.hu/api/create \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ "apikey" : "f151ad38-53fd-4d60-b388-2132883ac7c8", "subscription": "87BA65C4F505C4F3", "make" : 3, "model" : 2259, "generation" : 30657, "price" : 15872000, "year": 2018, "km": 110100 , "tax": 1, "condition": 1, "draft": 1 }'Válasz üzenet - sikeres létrehozás esetén:
{ "message": "Advertisement was created.", "ad_id": "C680CBC94BAE5D5E" }Hirdetés módosítása Kiválasztott hirdetés módosításához a https://autotveszek.hu/api/update erőforrást POST metódussal kell használjuk, meghívásakor az alábbi mezők megadása lehetséges - a nem definiált mezők változatlanok maradnak:
NÉV | TÍPUS | KÖTELEZŐ | LEÍRÁS |
---|---|---|---|
apikey | szöveg | igen | Saját API kulcs |
subscription | szöveg | igen | Előfizetés azonosító |
ad_id | szöveg | igen | Hirdetés azonosító |
condition | egész szám | nem | Gépjármű kondíció azonosító (1: használt, 2: új gépjármű) |
draft | egész szám | igen | Hirdetés piszkozat (1: nem piszkozat, 2: piszkozat - rejtett) |
price | egész szám | nem | Feltüntetett ár HUF -ban |
tax | egész szám | nem | Árhoz tartozó ÁFA beállítás (0: nem ÁFÁ-s, 1: ÁFÁ-s) |
status | egész szám | nem | Gépjármű állapota (1: normál, 2: újszerű, 3: enyhén sérült, 4: törött, 5: hiányos) |
position | egész szám | nem | Hirdetés pozíciója (1: aktív, 2: eladva, 3: törölve) |
year | egész szám | nem | Forgalomba helyezés évjárata |
km | egész szám | nem | Futott kilométer |
inspection_year | egész szám | nem | Műszaki vizsga érvényesség éve |
inspection_month | egész szám | nem | Műszaki vizsga érvényesség hónapja |
vin | szöveg | nem | Alvázszám |
color_exterior | szöveg | nem | Külső szín angolul (beige, black, blue, brown, gold, green, grey, orange, purple, red, silver, white, yellow, claret, 0: nincs megadva) |
color_exterior_2 | szöveg | nem | Második külső szín angolul (beige, black, blue, brown, gold, green, grey, orange, purple, red, silver, white, yellow, claret, 0: nincs megadva) |
color_interior | szöveg | nem | Beltér szín angolul (beige, black, blue, brown, gold, green, grey, orange, purple, red, silver, white, yellow, claret, 0: nincs megadva) |
color_interior_2 | szöveg | nem | Második beltér szín angolul (beige, black, blue, brown, gold, green, grey, orange, purple, red, silver, white, yellow, claret, 0: nincs megadva) |
color_metallic | egész szám | nem | Metálfényezés azonosító (0: nem, 1: igen) |
color_pearl | egész szám | nem | Gyöngyház fényezés azonosító (0: nem, 1: igen) |
cylinder_ccm | egész szám | nem | Lökettérfogat cm3 -ben |
cylinder_position | szöveg | nem | Henger pozíciója (inline: soros, v: V elrendezés, w: W elrendezés, wankel: Wankel motor) |
cylinder_count | egész szám | nem | Hengerek száma |
body | szöveg | nem | Gépjármű kivitel (cabriolet: Kabrió, combi: Kombi, mpv: Egyterű, coupe: Kupé, crossover: Városi terepjáró, hatchback: Ferdehátú, suv: SUV, sedan: Szedán, pickup: Pick-up) |
fuel | szöveg | nem | Üzemanyag típusa (diesel: Gázolaj, electricity: Elektromos, hydrogen: Hidrogén, petrol: Benzin, petrol_cng: CNG-benzin, petrol_ethanol:Etanol-benzin, petrol_lpg: LPG-benzin, hybrid_diesel: Hibrid-dízel, hybrid_petrol: Hibrid-benzines) |
power | egész szám | nem | Motor teljesítménye (LE) |
torque | egész szám | nem | Forgatónyomaték (Nm) |
drive | szöveg | nem | Hajtás (front: Első kerék, rear: Hátsó kerék, all: Összkerék) |
transmission | egész szám | nem | Váltó típus azonosító (0: Manuális, 1: Automata) |
gears | egész szám | nem | Sebességek száma |
doors | egész szám | nem | Ajtók száma |
seats | egész szám | nem | Szállítható személyek száma |
description | szöveg | nem | Hirdetéshez tartozó szabadszavas leírás |
options | tömb | nem | Hirdetésben használt hirdetés opciók és extrák azonosítói. Az első szám a sorszámot jelöli, de a hirdetés megjelenítése szempontjából nem releváns. |
NÉV | TÍPUS | LEÍRÁS |
---|---|---|
ad_id | szöveg | Egyedi hirdetés azonosító, mellyel hivatkozhatunk a hirdetésre |
message | szöveg | Sikeres módosítás üzenete |
curl -X POST \ https://autotveszek.hu/api/update \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ "apikey" : "f151ad38-53fd-4d60-b388-2132883ac7c8", "ad_id" : "C680CBC94BAE5D5E", "subscription": "87BA65C4F505C4F3", "condition": "1", "draft": "1", "price": "18970000", "tax": "1", "status": "1", "position": "1", "year": "2012", "km": "12500", "inspection_year": "2019", "inspection_month": "11", "vin": "ABC12345", "color_exterior": "red", "color_exterior_2": "0", "color_interior": "black", "color_interior_2": "grey", "color_metallic": "1", "color_pearl": "0", "cylinder_ccm": "1995", "cylinder_position": "inline", "cylinder_count": "4", "body": "sedan", "fuel": "petrol", "power": "510", "torque": "250", "drive": "front", "transmission": "0", "gears": "8", "doors": "3", "seats": "4", "description": "Frissen szervizelt, nagyon #megkimelt állapotban.", "options": { "0": "1", "1": "8", "2": "12", "3": "13" } }'Minta módosítás válasza:
{ "message": "Advertisement was updated.", "ad_id": "C680CBC94BAE5D5E" }Hirdetéshez képek feltöltése A hirdetésünkhöz képek is feltölthetők az API-n keresztül, de csak úgy ha a képfájlok elérhetők az Internet felől egy ismert URL címen. A képfeltöltéshez a https://autotveszek.hu/api/images erőforrást POST metódussal kell használjuk, meghívásakor az alábbi mezők megadása lehetséges:
NÉV | TÍPUS | KÖTELEZŐ | LEÍRÁS |
---|---|---|---|
apikey | szöveg | igen | Saját API kulcs |
subscription | szöveg | igen | Előfizetés azonosító |
ad_id | szöveg | igen | Hirdetés azonosító |
images | tömb | igen | Képfájlok URL-jei tömbben. Az első szám a sorszámot jelöli, de a hirdetés megjelenítése szempontjából nem releváns. A fotók a hirdetésben a feltöltés sorrendjében fognak megjelenni, azaz az első fotó lesz a főkép, utána pedig sorban a többi. A rendszer a bélyegképeket (thumbnails) automatikusan készíti el. |
NÉV | TÍPUS | LEÍRÁS |
---|---|---|
ad_id | szöveg | Egyedi hirdetés azonosító, mellyel hivatkozhatunk a hirdetésre |
message | szöveg | Sikeres feltöltés üzenete |
curl -X POST \ https://autotveszek.hu/api/makes \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ "apikey" : "f151ad38-53fd-4d60-b388-2132883ac7c8", "ad_id" : "C680CBC94BAE5D5E", "subscription": "87BA65C4F505C4F3", "images": { "0": "http://www.tarhelyem.hu/kepek001/ABC123_8000_001.jpg", "1": "http://www.tarhelyem.hu/kepek001/ABC123_8000_002.jpg", "2": "http://www.tarhelyem.hu/kepek001/ABC123_8000_003.jpg" } }'Minta feltöltés válasza:
{ "message": "Advertisement's images was updated.", "ad_id": "C680CBC94BAE5D5E" }