API samochody.pl

Struktura pliku JSON

Przykładowy plik

Przykładowy plik JSON, który założy konto dealers, jeśli jeszcze ono nie istnieje, po czym wykona eksport oferty złożonej z jednego ogłoszenia:

{
  "registration_import": true,
  "name": "polmarket.pl",
  "did": "0734677",
  "dealer": {
    "firstname": "polmarket.pl",
    "dealer.firm_name": "POLMARKET.PL spółka z ograniczoną odpowiedzialnością spółka komandytowa",
    "address.street": "Poznańska 20B",
    "address.postcode": "65-137",
    "address.city": "Zielona Góra",
    "dealer.firm_address": "Zielona Góra",
    "location.type": "Point",
    "location.coordinates": [
        19.893652,
        50.070766
      ]
    },
    "contact.email": "[email protected]",
    "contact.phone": "530 606 040",
    "dealer.firm_phone": "530 606 040"
  },
  "cars": [
    {
      "_adtype": "car_ad",
      "$flat": {
        "_shortid": "fca_148602",
        "make": "Jeep",
        "model": "GLADIATOR",
        "data.equipment": "LAUNCH EDITION V6 3.0 Mjet 260 KM A8 4X4",
        "tracking.city": "Zielona Góra",
        "tracking.email": "[email protected]",
        "location.type": "Point",
        "location.coordinates": [
          19.477061,
          51.686346
        ],
        "price.price": 317000,
        "production_year": 2020,
        "color": "Biały",
        "description": "Polmarket przedstawia ofertę na samochód Jeep Gladiator w limitowanej wersji Launch Edition 3,0 CRD V6...",
        "options": [
          "Rurowe stopnie boczne",
          "Tempomat",
          "Tylne czujniki parkowania Parksense",
          "Tylne lampy LED",
          "Uchwyty do mocowania ładunku",
          "Alufelgi"
        ],
        "fuel": "Diesel",
        "data.doors": 4,
        "data.seats": 5,
        "data.displacement_capacity": 2987,
        "trim": "3.0L Turbo Diesel 264KM AT8 4WD",
        "data.engine_power": 264,
        "data.body_type": "Pick up",
        "data.truck_body_type": "Pick up",
        "data.drive": "Na obie osie",
        "data.gearbox": "Automatyczna",
        "vin": "1C6JJTFM7ML530684",
        "price.currency": "PLN"
      },
      "photos": [
        "https://cdn.fcapoland.pl/uploads/57/148602/3241479678ae4203363bdd9350387edb.jpg",
        "https://cdn.fcapoland.pl/uploads/57/148602/c043cdb99d29a649f3ee343d97f828ad.jpg",
        "https://cdn.fcapoland.pl/uploads/57/148602/4118134b1bd4d5bf5d5fed3a4361ad9c.jpg",
        "https://cdn.fcapoland.pl/uploads/57/148602/349b108783c618414ffc2e1bece99c4d.jpg",
        "https://cdn.fcapoland.pl/uploads/57/148602/afc8243f7a409ac8914aa1709536d44b.jpg"
      ]
    }
  ]
}

Po kolei omówimy strukturę pliku, występujące w niej pola oraz wartości, jakie te pola mogą przyjmować.

Korzeń dokumentu

{
  "registration_import": true,
  "name": "polmarket.pl",
  "did": "0734677",
  "dealer": { ... },
  "cars": [ ... ]
}
registration_importBooleanwymaganeGdy true, założy konto dealera, jeśli nie istnieje ono w serwisie. Ustawienie wymagane u dealerów, którzy nie mają konta na Samochody.pl
nameStringwymaganeUnikatowy identyfikator tekstowy, wskazujący źródło importu, np. firmę lub portal. Skontatkuj się z Samochody.pl, aby otrzymać identyfikator.
didStringwymaganeUnikatowy identyfikator dealera lub komisu, może być to bazodanowe ID.
dealerObjectwymaganeObiekt z danymi dealera lub komisu. Struktura omawiana w dalszej części dokumentu.
carsArraywymaganeTablica z ofertą dealera lub komisu. Struktura w dalszej części dokumentu.

Dane komisu

{
 ...

  "dealer": {
    "firstname": "polmarket.pl",
    "dealer.firm_name": "POLMARKET.PL spółka z ograniczoną odpowiedzialnością spółka komandytowa",
    "address.street": "Poznańska 20B",
    "address.postcode": "65-137",
    "address.city": "Zielona Góra",
    "dealer.firm_address": "Zielona Góra",
    "location.type": "Point",
    "location.coordinates": [
        19.893652,
        50.070766
      ]
    },
    "contact.email": "[email protected]",
    "contact.phone": "530 606 040",
    "dealer.firm_phone": "530 606 040"
  },

  ...
}
firstnameStringwymaganeImię i nazwisko właściciela komisu lub identyfikator źródła eksportu
dealer.firm_nameStringwymaganeNazwa firmy dealera.
address.streetStringwymaganeUlica, na której znajduje się komis.
address.postcodeStringwymaganeKod pocztowy komisu.
address.cityStringwymaganeMiasto, w którym znajduje się komis.
dealer.firm_addressStringwymaganePełny adres komisu, opcjonalnie nazwa miasta.
location.typeStringwymaganeRodzaj lokalizacji. Przyjmuje wartość Point
location.coordinatesArraywymaganeWspółrzędne geograficzne komisu - najpierw długość, potem szerokość geograficzna w formacie Float.
contact.emailStringwymaganeEmail dealera.
contact.phoneStringwymaganeNumer telefonu właściciela.
dealer.firm_phoneStringwymaganeNumer telefonu komisu.

Dane ogłoszeń

Tablica cars może zawierać dowolną ilość obiektów z danymi ogłoszenia. U korzenia, pojedynczy obiekt zawiera 3 pola:

{
 ...

  "cars": [
    {
      "_adtype": "car_ad",
      "$flat": { ... },
      "photos": [
        "https://cdn.fcapoland.pl/uploads/57/148602/3241479678ae4203363bdd9350387edb.jpg",
        "https://cdn.fcapoland.pl/uploads/57/148602/c043cdb99d29a649f3ee343d97f828ad.jpg",
        "https://cdn.fcapoland.pl/uploads/57/148602/4118134b1bd4d5bf5d5fed3a4361ad9c.jpg",

    ...
      ]
    }
  ]
}
_adtypeStringwymaganeKategoria danego ogłoszenia. Przyjmuje jedną z wartości: car_ad, truck_ad, motorcyle_ad, part_ad, agri_ad, budowlane, przyczepy
photosArraywymaganeTablica z linkami do zdjęć pojazdu w formacie String
$flatObjectwymaganeDane ogłoszenia w 'płaskim' formacie ze znakiem kropki oznaczającym zagnieżdżenie. Opisany poniżej:
{
 ....

  "$flat": {
    "_shortid": "fca_148602",
    "make": "Jeep",
    "model": "GLADIATOR",
    "data.equipment": "LAUNCH EDITION V6 3.0 Mjet 260 KM A8 4X4",
    "tracking.city": "Zielona Góra",
    "tracking.email": "[email protected]",
    "location.type": "Point",
    "location.coordinates": [
      19.477061,
      51.686346
    ],
    "price.price": 317000,
    "production_year": 2020,
    "color": "Biały",
    "description": "Polmarket przedstawia ofertę na samochód Jeep Gladiator...",
    "options": [
      "Tempomat",
      "Tylne czujniki parkowania Parksense",
      "Tylne lampy LED",
      "Uchwyty do mocowania ładunku",
      "Alufelgi",

   ...
    ],
    "fuel": "Diesel",
    "data.doors": 4,
    "data.seats": 5,
    "data.displacement_capacity": 2987,
    "trim": "3.0L Turbo Diesel 264KM AT8 4WD",
    "data.engine_power": 264,
    "data.body_type": "Pick up",
    "data.truck_body_type": "Pick up",
    "data.drive": "Na obie osie",
    "data.gearbox": "Automatyczna",
    "vin": "1C6JJTFM7ML530684",
    "price.currency": "PLN"
  },

 ....
}
_shortidStringwymaganeUnikatowe ID ogłoszenia z przedrostkiem identyfikującym źródło importu, np. fca_. Może być bazodanowym ID ogłoszenia z przedrostkiem - identyfikatorem. Aby otrzymać identyfikator, skontatkuj się z Samochody.pl
makeStringwymaganeMarka pojazdu.
modelStringwymaganeModel pojazdu.
data.equipmentStringopcjonalneWersja wyposażenia pojazdu.
tracking.cityStringwymaganeMiasto, w którym znajduje się pojazd.
tracking.emailStringwymaganeEmail do kontaktu w sprawie pojazdu.
location.typeStringwymaganeRodzaj lokalizacji. Przyjmuje wartość Point
location.coordinatesArraywymaganeWspółrzędne geograficzne pojazdu - najpierw długość, potem szerokość geograficzna w formacie Float.
price.priceIntegerwymaganeCena.
production_yearIntegerwymaganeRok produkcji pojazdu.
colorStringopcjonalneKolor pojazdu. Przyjmuje jedną z wartości: Beżowy, Biały, Bordowy, Brązowy, Czarny, Czerwony, Fioletowy, Granatowy, Metaliczny, Niebieski, Pomarańczowy, Srebrny, Szary, Zielony, Złoty lub żółty, Inny
descriptionStringwymaganeOpis pojazdu. Może zawierać HTML.
optionsArraywymaganeTablica z listą wyposażenia pojazdu. Składowe w formacie String.
fuelStringwymaganeRodzaj paliwa pojazdu. Przyjmuje jedną z wartości: Benzyna, Diesel, Hybryda, Hybryda Plug-in, Elektro, Gaz
data.doorsIntegeropcjonalneIlość drzwi w pojeździe.
data.seatsIntegeropcjonalneIlość miejsc.
data.displacement_capacityIntegerwymaganePojemność skokowa / silnika pojazdu w cm³.
trimStringopcjonalneRodzaj modelu / silnika pojazdu.
data.engine_powerIntegerwymaganeMoc silnika w KM.
data.body_typeStringwymaganeRodzaj nadwozia lub typ pojazdu. Przyjmuje jedną z wartości: Cabrio, Coupe, Crossover, Fastback, Hardtop, Hatchback, Kombi, Liftback, Limuzyna, Minivan, Pickup, Roadster, Sedan, Sportowe, SUV, Targa, Zabytkowe, Poleasingowy, 7 osobowy, Chopper, Cruiser, Enduro, Krossowy, Motorower, Naked, Quad, Skuter, Skuter wodny, Sportowy, Turystyczny, Prawo jazdy kat. B, Inne
data.truck_body_typeStringopcjonalneRodzaj nadwozia / typ ciężarówki lub pojazdu dostawczego. Przyjmuje jedną z wartości: Ciężarowe, Autobusy, Autolaweta, Wywrotka, Platformy, Do zabudowy, Chłodnia/Izoterma, Specjalny, Doka, Furgon, Van, Kontener, Kamper, Plandeka, Mikrobus, Skrzynia, Pickup, Poleasingowy, 7 osobowy
data.driveStringopcjonalneRodzaj napędu pojazdu. Przyjmuje jedną z wartości: front, back, 4by4, Łańcuch, Pas napędowy, Wał kardana
data.gearboxStringopcjonalneRodzaj skrzyni biegów pojazdu. Przyjmuje jedną z wartości: manual, automatic, Automatyczna, Bezstopniowa, Manualna, Półautomatyczna
vinStringopcjonalneVIN pojazdu.
price.currencyStringwymaganeWaluta powiązana z ceną. Przyjmuje wartość PLN

Kontakt i wsparcie

Aby otrzymać dostęp do serwera FTP, wsparcie techniczne oraz informacje potrzebne do przeprowadzenia integracji, skontaktuj się z zespołem Samochody.pl przy pomocy formularza na stronie Kontakt Samochody.pl

list