otomoto WebAPI dokumentacja usługi sieciowej serwisu otomoto.pl dla dealerów wersja 2.2

Transkrypt

1 otomoto WebAPI dokumentacja usługi sieciowej serwisu otomoto.pl dla dealerów wersja 2.2 otomoto 2010

2 Wstęp Serwis otomoto.pl udostępnia usługę sieciową (web service) opartą na protokole SOAP, służącą do komunikacji z serwisem i realizacji usług takich jak zamieszczanie czy edycja ogłoszeń. Usługa zdefiniowana jest za pomocą języka WSDL i może być łatwo implementowana niezależnie od wykorzystywanej platformy po stronie klienta. W dalszej części dokumentu usługa nazwana jest otomoto WebAPI. Dostęp do otomoto WebAPI w wersji testowej oraz opis wykorzystywanych metod i typów danych: specyfikacja WSDL: Dostęp do otomoto WebAPI w wersji produkcyjnej oraz opis wykorzystywanych metod i typów danych: specyfikacja WSDL: Dostęp do otomoto WebAPI dla Dealerów Aby uzyskać dostęp do interfejsu otomoto WebAPI niezbędne jest posiadanie własnego klucza dostępowego oraz aktywne konto dealera w serwisie otomoto. W celu otrzymania klucza należy skontaktować się z Działem Technicznym otomoto telefonicznie lub wysyłając w tej sprawie na adres: tech@otomoto.pl. Pobieranie listy możliwych kluczy dodatkowych informacji $parameters = array( 'webapi-key' => 'ABCA C079584C1B6C86A791D7', 'type' => 'CAR' ); $response = $client->call('getvehiclefeatures', $parameters); otomoto /25

3 Pobieranie listy możliwych kluczy dodatkowego wyposażenia $parameters = array( 'webapi-key' => 'ABCA C079584C1B6C86A791D7', 'type' => 'CAR' ); $response = $client->call('getvehicleextras', $parameters); W odpowiedzi otrzymamy listę kluczy dodatkowego wyposażenia/dodatkowych informacji wraz z nazwami. Kluczy tych można użyć w vehicle-extras-list i vehicle-features-list. Dodawanie/edycja ogłoszeń W celu dodawania/edycji ogłoszenia należy w pierwszej kolejności zalogować się wywołując metodę dodealerlogin(). Wywołanie metody zwróci identyfikator sesji session-id. Identyfikator sesji będzie wykorzystany w wywołaniach innych metod np. doinsertionedit() pozwalającej dodawać/edytować ogłoszenia. Kolejnym krokiem jest przygotowanie obiektu reprezentującego pojedyncze ogłoszenie (typ Insertion w otomoto WebAPI). Po przygotowaniu obiektu można już wywołać metodę doinsertionedit() przekazując do niej następujące parametry: identyfikator sesji, obiekt ogłoszenia oraz webapi-key. Każde wywołanie doinsertionedit() zwraca obiekt ogłoszenia lub też informacje o ewentualnych błędach. otomoto /25

4 Atrybuty dla samochodu osobowego [car] w strukturze Insertion Lp. Nazwa Znaczenie Wymagany Wartości Opis 1. id Numer ogłoszenia dodawanie TAK edycja STR {1, 11}: wartość doinsertionedit() Przy dodawaniu ogłoszenia ten atrybut jest pusty. Po wykonaniu pozytywnym doinsertionedit() można odczytać wartość. Należy się nią posłużyć przy edycji. 2. remote-id Id ogłoszenia STR {0, 64} Nr ogłoszenia z bazy dealera/partnera 3. allegro-cat-id Kategoria Allegro TAK INT: wartość zwracana getallegrocategories() 4. type Typ ogłoszenia TAK ENUM: {'CAR'} Typ ogłoszenia określa listę parametrów wejściowych 5. make-id Marka TAK INT {1, 10}: wartość getmakes() 6. model-id model-name 7. model-name-extension Dodatkowy opis modelu Model TAK INT {1, 10}: wartość getmodels() STR {1, 40} Marka pojazdu Model pojazdu. Tylko jeden z tych parametrów powinien być ustawiony. STR {0, 100} Dodatkowy opis również wyświetlany w wynikach wyszukiwania 8. price Cena TAK FLOAT (1, 10; 2) Cena, dokładność do 2 miejsc po przecinku 9. price-currency Waluta TAK STR {3}: wartość zwracana getallowedcurrencies() 10. price-type-key Typ ceny TAK ENUM: {'brutto ', 'netto'} Domyślnie: PLN 11. price-negotiable Do negocjacji ENUM: {'n', 'y'} Cena do negocjacji 12. build-year Rok produkcji TAK INT {4} Rok produkcji, format: RRRR, np tech-check-year Przegląd INT {0,4} Rok przeglądu, format: RRRR, np tech-check-month Przegląd INT {0,2} Miesiąc przeglądu, format: MM, 03, (lub 3) 15. insurance-year Ubezpieczenie OC INT {0,4} Rok ubezpieczenia, format: RRRR, np. 2005

5 16. insurance-month Ubezpieczenie OC INT {0,2} Miesiąc ubezpieczenia, format: MM, 03, (lub 3) 17. first-registration-year Pierwsza rejestracja INT {0,4}: Rok pierwszej rejestracji, format: RRRR, np first-registration-month Pierwsza rejestracja INT {0,2} Miesiąc pierwszej rejestracji, format: MM, 03, (lub 3) 19. odometer Przebieg INT {0, 10} Przebieg w km 20. power Moc INT {0, 10} 21. power-unit Jednostka mocy ENUM: {'kw', 'PS'} Jednostka mocy: KW - kw KM - PS 22. fuel-type-key Rodzaj paliwa ENUM: wartość zwracana getfueltypes() 23. gearbox-type-key Skrzynia biegów ENUM: wartość zwracana getgearboxtypes() 24. colour-key Kolor ENUM: wartość zwracana getcolours() 25. colour-metallic Metalik ENUM: {'n', 'y'} 26. doors-key Liczba drzwi ENUM: {'2/3', '4/5'} 27. cubic-capacity Pojemność skokowa INT {0, 8} Pojemność skokowa w cm damaged Pojazd uszkodzony TAK ENUM: ('n', 'y') 29. vehicle-category-key Typ TAK ENUM: wartość zwracana getvehiclecategories() 30. vehicle-extras-list Dodatkowe wyposażenie 31. vehicle-features-list Dodatkowe informacje ARRAY ArrayOfVehicleExtras: wartość zwracana przez metodę: getvehicleextras() ARRAY ArrayOfVehicleFeatures: wartość zwracana przez metodę: getvehiclefeatuers() Typ nadwozia Jako parametr przy wywołaniu getvehiclecategories() należy podać typ nadwozia 'CAR' Jako parametr przy wywołaniu getvehicleextras() należy podać typ nadwozia 'CAR' Jako parametr przy wywołaniu getvehiclefeatures() należy podać typ nadwozia 'CAR'

6 32 description Opis STR {0, } Opis pojazdu 33. seller- wystawiającego 34. origin-status Status pojazdu sprowadzonego 35. origin-country Kraj pochodzenia pojazdu 36. registration-country Kraj aktualnej rejestracji 37. vin Numer identyfikacji pojazdu STR {0, 64} ENUM {'1', '2', '3', '4'} 1 => do sprowadzenia ; 2=> sprowadzony/nieopłacony ; 3 => przygotowany do rejestracji/opłacony ; 4 => sprowadzony/zarejestrowany STR{0, 3}: wartość getcountries() STR{0, 3}: wartość getcountries() STR{17} Następujące pary atrybutów w tablicy $vehicle_features_list wzajemnie się wykluczają i nie mogą występować razem: Lp. Atrybut 1 Atrybut 2 1. new_vehicle oldtimer 2 new_vehicle first_owner 3. new_vehicle aso_service 4. new_vehicle garaged Jeżeli atrybut 'new_vehicle' w tablicy $vehicle_features_list jest ustawiony to pole 'build-year' powinno być ustawione na przedostatni rok (np. jeżeli teraz jest 2008, to 'build-year' musi być większy lub równy 2007). Jeżeli atrybut 'new_vehicle' w tablicy $vehicle_features_list jest ustawiony to pole 'damaged' nie może być ustawione na 'y'. Atrybuty dla samochodu ciężarowego [truck] w strukturze Insertion

7 1. id Numer ogłoszenia dodawanie TAK edycja STR {1, 11} - wartość doinsertionedit() Przy dodawaniu ogłoszenia ten atrybut jest pusty. Po wykonaniu pozytywnym doinsertionedit() można odczytać wartość. Należy się nią posłużyć przy edycji. 2. remote-id Id ogłoszenia STR {0, 64} Nr ogłoszenia z bazy dealera/partnera 3. allegro-cat-id Kategoria Allegro TAK INT: wartość zwracana getallegrocategories() 4. type Typ ogłoszenia TAK ENUM: {'TRUCK'} Typ ogłoszenia określa listę parametrów wejściowych 5. make-id Marka TAK INT {1, 10}: wartość getmakes() Marka pojazdu 6. model-name Model TAK STR {1, 40} Model pojazdu 7. price Cena TAK FLOAT (1, 10; 2) Cena, dokładność do 2 miejsc po przecinku 8. price-currency Waluta TAK STR {3}: wartość zwracana getallowedcurrencies() 9. price-type-key Typ ceny TAK ENUM: {'brutto ', 'netto'} Domyślnie: PLN 10. price-negotiable Do negocjacji ENUM: ('n', 'y') Cena do negocjacji 11. build-year Rok produkcji TAK INT {4} Rok produkcji, format: RRRR, np tech-check-year Przegląd INT {0,4} Rok przeglądu, format: RRRR, np tech-check-month Przegląd INT {0,2} Miesiąc przeglądu, format: MM, 03, (lub 3) 14. insurance-year Ubezpieczenie OC INT {0,4} Rok ubezpieczenia, format: RRRR, np insurance-month Ubezpieczenie OC INT {0,2} Miesiąc ubezpieczenia, format: MM, 03, (lub 3) 16. first-registration-year Pierwsza rejestracja INT {0,4}: Rok pierwszej rejestracji, format: RRRR, np first-registration-month Pierwsza rejestracja INT {0,2} Miesiąc pierwszej rejestracji, format: MM, 03, (lub 3) 18. odometer Przebieg INT {0, 10} Przebieg w km 19. power Moc INT {0, 10} 20. power-unit Jednostka mocy ENUM: {'kw', 'PS'} Jednostka mocy: KW - kw KM - PS

8 21. fuel-type-key Rodzaj paliwa ENUM: wartość zwracana getfueltypes() 22. colour-key Kolor ENUM: wartość zwracana getcolours() 23. colour-metallic Metalik ENUM: {'n', 'y'} 24. load-capacity Ładowność INT {0, 8} Ładowność w kg 25. axis-num Liczba osi INT {0, 8} 26. damaged Pojazd uszkodzony TAK ENUM: {'n', 'y'} 27. vehicle-category-key Typ TAK STR: wartość zwracana getvehiclecategories() 28. vehicle-extras-list Dodatkowe wyposażenie 29. vehicle-features-list Dodatkowe informacje ARRAY ArrayOfVehicleExtras: wartość zwracana przez metodę: getvehicleextras() ARRAY ArrayOfVehicleFeatures: wartość zwracana przez metodę: getvehiclefeatuers() 30. description Opis STR {0, } Opis pojazdu 31. seller- wystawiającego 32. origin-status Status pojazdu sprowadzonego 33. origin-country Kraj pochodzenia pojazdu 34. registration-country Kraj aktualnej rejestracji STR {0, 64} Typ nadwozia (np. hatchback, sedan). Jako parametr przy wywołaniu getvehiclecategories() należy podać typ nadwozia 'TRUCK' Jako parametr przy wywołaniu getvehicleextras() należy podać typ nadwozia 'TRUCK' Jako parametr przy wywołaniu getvehiclefeatures() należy podać typ nadwozia 'TRUCK' ENUM {'1', '2', '3', '4'} 1 => do sprowadzenia ; 2=> sprowadzony/nieopłacony ; 3 => przygotowany do rejestracji/opłacony ; 4 => sprowadzony/zarejestrowany STR{0, 3}: wartość getcountries() STR{0, 3}: wartość

9 35. vin Numer identyfikacji pojazdu getcountries() STR{17} Następujące pary atrybutów w tablicy $vehicle_features_list wzajemnie się wykluczają i nie mogą występować razem: Lp. Atrybut 1 Atrybut 2 1 new_vehicle first_owner 2. new_vehicle aso_service 3. new_vehicle aso_bought Jeżeli atrybut 'new_vehicle' w tablicy $vehicle_features_list jest ustawiony to pole 'build-year' powinno być ustawione na przedostatni rok (np. jeżeli teraz jest 2008, to 'build-year' musi być większy lub równy 2007). Jeżeli atrybut 'new_vehicle' w tablicy $vehicle_features_list jest ustawiony to pole 'damaged' nie może być ustawione na 'y'. Atrybuty dla motocykla [motorbike] w strukturze Insertion Lp. Nazwa Znaczenie Wymagany Wartości Opis 1. id Numer ogłoszenia dodawanie TAK edycja STR {1, 11} - wartość doinsertionedit() Przy dodawaniu ogłoszenia ten atrybut jest pusty. Po wykonaniu pozytywnym doinsertionedit() można odczytać wartość. Należy się nią posłużyć przy edycji. 2. remote-id Id ogłoszenia STR {0, 64} Nr ogłoszenia z bazy dealera/partnera 3. allegro-cat-id Kategoria Allegro TAK INT {1, 16}: wartość getallegrocategories() 4. type Typ ogłoszenia TAK STR: 'MOTORBIKE' Typ ogłoszenia określa listę parametrów wejściowych 5. make-id Marka TAK INT {1, 10}: wartość Marka pojazdu

10 getmakes() 6. model-id Model TAK INT {1, 10}: wartość getmodels() model-name STR {1, 40} 7. model-name-extension Dodatkowy opis modelu Model pojazdu. Tylko jeden z tych parametrów powinien być ustawiony. STR {0, 100} Dodatkowy opis również wyświetlany w wynikach wyszukiwania 8. price Cena TAK FLOAT (1, 10; 2) Cena, dokładność do 2 miejsc po przecinku 9. price-currency Waluta TAK STR {3}: wartość getallowedcurrencies() 10. price-type-key Typ ceny TAK ENUM: {'brutto ', 'netto'} Domyślnie: PLN 11. price-negotiable Do negocjacji ENUM: {n', 'y'} Cena do negocjacji 12. build-year Rok produkcji TAK INT {4} Rok produkcji, format: RRRR, np tech-check-year Przegląd INT {0,4} Rok przeglądu, format: RRRR, np tech-check-month Przegląd INT {0,2} Miesiąc przeglądu, format: MM, 03, (lub 3) 15. insurance-year Ubezpieczenie OC INT {0,4} Rok ubezpieczenia, format: RRRR, np insurance-month Ubezpieczenie OC INT {0,2} Miesiąc ubezpieczenia, format: MM, 03, (lub 3) 17. first-registration-year Pierwsza rejestracja INT {0,4}: Rok pierwszej rejestracji, format: RRRR, np first-registration-month Pierwsza rejestracja INT {0,2} Miesiąc pierwszej rejestracji, format: MM, 03, (lub 3) 19. odometer Przebieg INT {0, 10} Przebieg w km 20. power Moc INT {0, 10} 21. power-unit Jednostka mocy ENUM: {'kw, 'PS'} Jednostka mocy: KW - kw KM - PS 22. fuel-type-key Rodzaj paliwa ENUM: wartość zwracana getfueltypes() 23. gearbox-type-key Skrzynia biegów ENUM: wartość zwracana

11 getgearboxtypes() 24. colour-key Kolor ENUM: wartość zwracana getcolours() 25. colour-metallic Metalik ENUM: {'n', 'y'} 26. transmission-key Rodzaj napędu ENUM: wartość zwracana gettransmissiontypes() 27. cubic-capacity Pojemność skokowa INT {0, 8} Pojemność skokowa w cm damaged Pojazd uszkodzony TAK ENUM: {'n', 'y'} 29. vehicle-category-key Typ TAK ENUM: wartość zwracana getvehiclecategories() 30. vehicle-extras-list Dodatkowe wyposażenie 31. vehicle-features-list Dodatkowe informacje ARRAY ArrayOfVehicleExtras: wartość zwracana przez metodę: getvehicleextras() ARRAY ArrayOfVehicleFeatures: wartość zwracana przez metodę: getvehiclefeatuers() 32. description Opis STR {0, } Opis pojazdu 33. seller- wystawiającego STR {0, 64} 34. origin-status Status pojazdu sprowadzonego 35. origin-country Kraj pochodzenia pojazdu 36. registration-country Kraj aktualnej rejestracji Typ nadwozia Jako parametr przy wywołaniu getvehiclecategories() należy podać typ nadwozia 'MOTORBIKE' Jako parametr przy wywołaniu getvehiclefeatures() należy podać jeden z typów 'MOTORBIKE', 'MOTO- BIKE', 'SCOOTER', 'QUAD' Jako parametr przy wywołaniu getvehicleextras() należy podać typ nadwozia 'MOTORBIKE' ENUM {'1', '2', '3', '4'} 1 => do sprowadzenia ; 2=> sprowadzony/nieopłacony ; 3 => przygotowany do rejestracji/opłacony ; 4 => sprowadzony/zarejestrowany STR{0, 3}: wartość getcountries() STR{0, 3}: wartość getcountries()

12 37. vin Numer identyfikacji pojazdu STR{17} Następujące pary atrybutów w tablicy $vehicle_features_list wzajemnie się wykluczają i nie mogą występować razem: Lp. Atrybut 1 Atrybut 2 1. new_vehicle oldtimer Jeżeli atrybut 'new_vehicle' w tablicy $vehicle_features_list jest ustawiony to pole 'build-year' powinno być ustawione na przedostatni rok (np. jeżeli teraz jest 2008, to 'build-year' musi być większy lub równy 2007). Jeżeli atrybut 'new_vehicle' w tablicy $vehicle_features_list jest ustawiony to pole 'damaged' nie może być ustawione na 'y'. Atrybuty dla części [part] w strukturze Insertion Lp. Nazwa Znaczenie Wymagany Wartości Opis 1. id Numer ogłoszenia dodawanie TAK edycja STR {1, 11}: wartość doinsertionedit() Przy dodawaniu ogłoszenia ten atrybut jest pusty. Po wykonaniu pozytywnym doinsertionedit() można odczytać wartość. Należy się nią posłużyć przy edycji. 2. remote-id Id ogłoszenia STR {0, 64} Nr ogłoszenia z bazy dealera/partnera 3. type Typ ogłoszenia TAK ENUM: {'PART'} Typ ogłoszenia określa listę parametrów wejściowych 4. make-id Marka TAK INT {1, 10}: wartość getmakes() Marka pojazdu 5. model-name Model TAK STR {0, 40} Model pojazdu 6. price Cena TAK FLOAT (1, 10; 2) Cena, dokładność do 2 miejsc po przecinku 7. price-currency Waluta TAK STR {3}: wartość getallowedcurrencies() Domyślnie: PLN

13 8. price-type-key Typ ceny TAK ENUM: {'brutto ', 'netto'} 9. price-negotiable Do negocjacji ENUM: {'n', 'y'} Cena do negocjacji 10. build-year Rok produkcji TAK INT {4} Rok produkcji, format: RRRR, np description Opis STR {0, } Opis pojazdu 12. seller- wystawiającego STR {0, 64} 13. vehicle-kind Rodzaj pojazdu TAK ENUM: wartość zwracana getvehiclekinds() 14. part-category Kategoria TAK STR: wartość zwracana getpartcategories() 15. new-part Czy część jest nowa ENUM: {'y', 'n'} Rodzaj pojazdu determinuje listę dostępnych kategorii. Metoda wywoływana z parametrem 'PARTS' Kategoria części. Metodę getpartcategories() należy sparametryzować poprzez vehicle-kind Atrybuty dla pozostałych [other] w strukturze Insertion Lp. Nazwa Znaczenie Wymagany Wartości Opis 1. id Numer ogłoszenia dodawanie TAK edycja STR {1, 11}: wartość doinsertionedit() Przy dodawaniu ogłoszenia ten atrybut jest pusty. Po wykonaniu pozytywnym doinsertionedit() można odczytać wartość. Należy się nią posłużyć przy edycji. 2. remote-id Id ogłoszenia STR {0, 64} Nr ogłoszenia z bazy dealera/partnera 3. allegro-cat-id Kategoria Allegro TAK INT {1, 16}: wartość getallegrocategories() 4. type Typ ogłoszenia TAK STR: {'OTHER'} Typ ogłoszenia określa listę parametrów wejściowych 5. make-id Marka /TAK INT {1, 10}: wartość getmakes() 6. model-name Model STR {0, 40} Model pojazdu Marka pojazdu. Atrybuty istnieje tylko w przypadku vehicle-kind: {'forklift', 'bike'}. Są to również parametry dla metody getmakes()

14 7. price Cena TAK FLOAT (1, 10; 2) Cena, dokładność do 2 miejsc po przecinku 8. price-currency Waluta TAK STR {3}: wartość zwracana getallowedcurrencies() 9. price-type-key Typ ceny TAK ENUM: {'brutto ', 'netto'} Domyślnie: PLN 10. price-negotiable Do negocjacji ENUM: {'n', 'y'} Cena do negocjacji 11. build-year Rok produkcji TAK INT {4} Rok produkcji, format: RRRR, np odometer Motogodziny INT {0, 10} Przebieg w km 13. power Moc INT {0, 10} 14. power-unit Jednostka mocy ENUM: {'kw', 'PS'} Jednostka mocy: KW - kw KM - PS 15. fuel-type-key Rodzaj paliwa ENUM: wartość zwracana getfueltypes() 16. cubic-capacity Pojemność skokowa INT {0, 8} Pojemność skokowa w cm damaged Pojazd uszkodzony TAK ENUM: {'n', 'y'} 18. vehicle-extras-list Dodatkowe wyposażenie ARRAY ArrayOfVehicleExtras: wartość zwracana przez metodę: getvehicleextras() 19. description Opis STR {0, } Opis pojazdu 20 seller- wystawiającego STR {0, 64} 21. vehicle-kind Rodzaj pojazdu TAK ENUM: wartość zwracana getvehiclekinds() 22. vehicle-type Typ TAK ENUM: wartość zwracana getvehiclecategories() 23. drive-kind Rodzaj napędu ENUM: {'chain', 'shaft', 'waterstream', 'bold', Jako parametr przy wywołaniu getvehicleextras() należy podać parameter vehicle-category-key Rodzaj pojazdu Jako parametr przy wywołaniu getvehiclekinds() z parametrem 'OTHERS' Typ. Jako parametr przy wywołaniu getvehiclecategories() należy podać vehicle-kind Poprawne wartości dla określonego rodzaju pojazdu: 'build' -> 'circles', 'caterpillar'

15 'circles', 'caterpillar', 'outboard_motor'} 24. weight Waga podnoszenia INT {0, 10} Waga w tonach 25. cylinder-numbers Ilość cylindrów INT {0, 4} 26. wheel-numbers Liczba kół INT {0, 4} 27. tonnage Udźwig INT {0, 10} 28. bringing-height Wysokość podnoszenia 29. place-numbers Ilość miejsc INT {0, 3} 30. engine-numbers Ilość silników INT {0, 3} 31. propeller-blade-numbers Ilość łopat śmigła INT {0, 3} 32. motohour-numbers-to-review Motogodzin do przeglądu 'water' -> 'bold', 'waterstream', 'outboard_motor' 'quad' -> 'chain', 'shaft', 'waterstream' INT {0, 10} Wysokość podnoszenia (w cm) INT {0, 10} 33. weight-kg Waga FLOAT (1, 3; 2) Waga roweru w kg 34. gear-numbers Ilość biegów INT {0, 2} Ilość biegów roweru 35. wheels-size Rozmiar kół INT {0, 2} Rozmiar kół roweru w calach Atrybuty dla maszyn budowlanych [construction] w strukturze Insertion Lp. Nazwa Znaczenie Wymagany Wartości Opis 1. id Numer ogłoszenia dodawanie TAK edycja STR {1, 11}: wartość doinsertionedit() Przy dodawaniu ogłoszenia ten atrybut jest pusty. Po wykonaniu pozytywnym doinsertionedit() można odczytać wartość. Należy się nią posłużyć przy edycji. 2. remote-id Id ogłoszenia STR {0, 64} Nr ogłoszenia z bazy dealera/partnera 3. allegro-cat-id Kategoria Allegro TAK INT {1, 16}: wartość getallegrocategories() 4. type Typ ogłoszenia TAK STR: Typ ogłoszenia określa listę parametrów wejściowych

16 {'CONSTRUCTION'} 5. make-id Marka /TAK INT {1, 10}: wartość getmakes() 6. model-name Model STR {0, 40} Model pojazdu Marka pojazdu. Atrybuty istnieje tylko w przypadku vehiclekind: {'forklift', 'bike'}. Są to również parametry dla metody getmakes() 7. price Cena TAK FLOAT (1, 10; 2) Cena, dokładność do 2 miejsc po przecinku 8. price-currency Waluta TAK STR {3}: wartość getallowedcurrencies() 9. price-type-key Typ ceny TAK ENUM: {'brutto ', 'netto'} Domyślnie: PLN 10. price-negotiable Do negocjacji ENUM: {'n', 'y'} Cena do negocjacji 11. build-year Rok produkcji TAK INT {4} Rok produkcji, format: RRRR, np odometer Motogodziny INT {0, 10} Przebieg w km 13. power Moc ENUM: z metody: getconstructiondictionar y(attribute-name='power') 14. gearbox-type-key Skrzynia biegów ENUM: z metody: getconstructiondictionar y(attributename='gearbox-type-key') 15. damaged Pojazd uszkodzony TAK ENUM: {'n', 'y'} 16. vehicle-category-key Typ TAK ENUM: z metody: getconstructiondictionar y(attributename='categor y') 17. vehicle-extras-list Dodatkowe wyposażenie ARRAY ArrayOfVehicleExtras: wartość zwracana przez metodę: getvehicleextras() Moc (w kva) 18. description Opis STR {0, } Opis pojazdu 19. seller- wystawiającego STR {0, 64} Jako parametr przy wywołaniu getvehicleextras() należy podać parameter vehicle-category-key

17 20. vehicle-type Rodzaj pojazdu TAK ENUM: z metody: getconstructiondictionar y(attributename='type') 21. drive-kind Rodzaj napędu ENUM: z metody: getconstructiondiłctionary(attributename=' drive-kind') 22. cylinder-numbers Ilość cylindrów INT {0, 10} Typ. Jako parametr przy wywołaniu należy podać vehiclecategory-key 23. operating-weight Masa eksploatacyjna INT {0, 10} Masa eksploatacyjna (w tys. kg) 24. max-bucket-capacity Pojemność łyżki INT {0, 10} 25. max-reach-digging-depth Maksymalny zasięg/głębokość kopania INT {0, 10} Maksymalny zasięg/głębokość kopania (w m) 26. boom Wysięgnik ENUM: z metody: getconstructiondictionar y(attributename='boom') 27. net-power Moc użyteczna INT {0, 10} Moc użyteczna (w KM) 28. track-width Szerokość gąsienic INT {0, 10} Szerokość gąsienic (w mm) 29. blade Lemiesz ENUM: z metody: getconstructiondictionar y(attributename='blade') 30. blade-width Szerokość lemiesza INT {0, 10} Szerokość lemiesza (w m)

18 Lista atrybutów dla pozostałych w zależności od rodzaju pojazdu Lp. Rodzaj pojazdu Atrybuty 1. wspólne dla wszystkich typów pojazdów Id remote-id allegro-cat-id type vehicle-kind model-name price price-currency price-negotiable vehicle-type build-year damaged description 2. build drive-kind motohours odometer weight cylinder-numbers 3. forklift make-id odometer tonnage bringing-height wheel-numbers fuel-type vehicle-extras-list 4. agro power power-unit wheel-numbers odometer vehicle-extras-list 5. water power power-unit cubic-capacity odometer place-numbers fuel-type drive-kind vehicle-extras-list 6. air power power-unit engine-numbers propeller-blade-numbers odometer motohour-numbers-to-review place-numbers vehicle-extras-list 7. snow power power-unit cubic-capacity odometer otomoto /25

19 Lp. Rodzaj pojazdu Atrybuty place-numbers drive-kind vehicle-extras-list 8. bike make-id weight-kg gear-numbers wheels-size vehicle-extras-list Lista atrybutów informacyjnych zwracanych przez metodę doinsertionedit() Lp. Atrybut Znaczenie 1. id Numer w bazie otomoto 2 make-name Nazwa marki (tam gdzie istnieje) 3. model-name Nazwa modelu 4. status Status ogłoszenia, dostępne wartości: ACT, EXP 5. photo-num Ilość zdjęć 6. views-num Liczba wyświetleń 7. modification-datetime Czas ostatniej modyfikacji 8. expiration-date Data wygaśnięcia ogłoszenia 9. short-link Skrócony link do ogłoszenia Po dodaniu/edycji ogłoszenia należy zakończyć sesję wywołując metodę dodealerlogout(). Metoda doinsertionedit() pozwala zarówno dodawać oraz edytować ogłoszenie. Jeśli w obiekcie ogłoszenia nie będzie podany atrybut id wtedy zostanie dodane nowe ogłoszenie natomiast gdy atrybut ten zostanie podany wtedy odbędzie się edycja ogłoszenia i będzie możliwa korekta danych ogłoszenia. Aby uprościć i przyspieszyć dodawanie/edycję ogłoszeń metodę doinsertionedit() można wywoływać wielokrotnie w ramach jednej sesji podstawiając do kolejnych wywołań kolejne ogłoszenia. Uwaga: Dodawanie zdjęć jest realizowane za pomocą odrębnej metody dophotoedit(). otomoto /25

20 Aktywacja ogłoszeń Aktywacja ogłoszenia jest realizowana za pomocą metody dodealerinsertionactivate(). Jako jeden z parametrów metoda ta przyjmuje obiekt Insertion. W tym przypadku obiekt Insertion musi posiadać tylko identyfikator ogłoszenia. Deaktywacja ogłoszeń Deaktywacja ogłoszenia jest realizowana za pomocą metody dodealerinsertioninactivate(). Jako jeden z parametrów metoda ta przyjmuje obiekt Insertion. W tym przypadku obiekt Insertion musi posiadać tylko identyfikator ogłoszenia. Usuwanie ogłoszeń Usuwanie ogłoszenia jest realizowane przez metodę doinsertiondelete(). Jako jeden z parametrów metoda ta przyjmuje obiekt Insertion. W przypadku usuwania ogłoszenia obiekt Insertion musi posiadać tylko identyfikator ogłoszenia. Wyszukiwanie ogłoszeń Do wyszukiwania ogłoszeń służą dwie metody: doinsertionsearch()i getinsertionsearchresults(). Pierwsza na podstawie podanych parametrów zwraca search-query-id. Druga zwraca wyniki wyszukiwania dla podanego search-query-id. Przykłady W przykładach wykorzystano testowe konto dealera z aktywnym kluczem WebAPI: webapi-key: ABCA C079584C1B6C86A79EEE Przykłady napisane są w języku PHP w wersji 4 i wykorzystują bibliotekę nusoap ( Logowanie Dealera <?php require_once('nusoap php'); //Parametry dla metody dodealerlogin $parameters = array( "dealer-login" => "tech4@otomoto.pl", "dealer-password" => " ", "webapi-key" => "ABCA C079584C1B6C86A79EEE" otomoto /25

21 ); //Utworzenie obiektu klienta $client = new soapclient(' 'wsdl' ); //wywolanie metody dodealerlogin $response = $client->call('dodealerlogin', $parameters); // W $response mamy w tablicy to, co zwrocil serwer: print_r($response); // Mozna rowniez zobaczyc odp. w XML-u: (print_r() wyzej // nalezy wtedy usunąć i odkomentować poniższe linie) // header("content-type: text/xml;"); // header("content-length: ".strlen($client->responsedata)); // echo $client->responsedata;...?> Dodawanie/edycja ogłoszenia <?php //przykladowy session-id: 113f4d58048d5dd567f efb9ae... //utworzenie ogloszenia $vehicle_features_list = array( array('key'=>'aso_service'), array('key'=>'aso_bought') ); $vehicle_extras_list = array( array('key'=>'abs'), array('key'=>'air_conditioning'), array('key'=>'sunroof'), array('key'=>'lpg') ); $insertion = array ( 'type' => 'car', 'vehicle-category-key' => 'combi', 'price' => '40000', 'price-negotiable' => 'y', 'price-currency' => 'PLN', 'make-id' => "3", 'model-name' => "Vectra", otomoto /25

22 'build-year' => '2001', 'cubic-capacity' => '2100', 'fuel-type-key' => 'petrol', 'country-id' => 'PL', 'province-id' => 17, 'city-name' => 'Poznań', 'vehicle-extras-list' => $vehicle_extras_list, 'vehicle-features-list' => $vehicle_features_list, ); //przygotowanie parametrow wywolania metody doinsertionedit $parameters = array( "insertion" => $insertion, "session-id"=> "113f4d58048d5dd567f efb9ae", "webapi-key" => "ABCA C079584C1B6C86A791D7" ); //wywolanie metody doinsertionedit $response = $client->call('doinsertionedit', $parameters); //wysietlenie odpowiedzi if($client->fault) { //sprawdzenie czy wystapil blad echo "FAULT: <p>code: {$client->faultcode}<br />"; echo "String: {$client->faultstring}"; } else { header("content-type: text/xml;"); header("content-length: ".strlen($client->responsedata)); echo $client->responsedata; }...?> Dodawanie/edycja zdjęcia <?php require_once('nusoap php'); $client = new soapclient(' 'wsdl' ); $inputfile = '<ŚCIEŻKA_DO_PLIKU>'; $file = fopen($inputfile, 'r'); otomoto /25

23 $imagedata = fread($file, filesize($inputfile)); fclose($file); $base64data = base64_encode($imagedata); $photo = array( 'number' => '<NUMER_OBRAZKA>', // można dodać lub zmienić obrazek 'body' => $base64data ); $parameters = array ( 'insertion-id' => '<ID_OGŁOSZENIA>', // na przykład C18848 'photo' => $photo, 'session-id' => '<ID_SESJI>', // zwracany przez dodealerlogin() 'webapi-key' => '<WEBAPI_KEY>' ); $response = $client->call('dophotoedit', $parameters); // wyswietlenie odpowiedzi if($client->fault) { // sprawdzanie czy nie wystąpił błąd echo "FAULT: <p>code: {$client->faultcode}<br />"; echo "String: {$client->faultstring}"; } else { header("content-type: text/xml;"); header("content-length: ".strlen($client->responsedata)); echo $client->responsedata; }...?> Aktywacja ogłoszenia <?php //przykladowy session-id: 113f4d58048d5dd567f efb9ae $insertion = array('id' => 'C186786'); $parameters = array( "insertion" => $insertion, otomoto /25

24 "session-id"=> "113f4d58048d5dd567f efb9ae", "webapi-key" => "ABCA C079584C1B6C86A791D7" ); //wywolanie metody WebAPI::doDealerInsertionActivate() $response = $client->call('dodealerinsertionactivate', $parameters); //wyswietlenie odpowiedzi if($client->fault) { //sprawdzenie czy wystapil blad echo "FAULT: <p>code: {$client->faultcode}<br />"; echo "String: {$client->faultstring}"; } else { header("content-type: text/xml;"); header("content-length: ".strlen($client->responsedata)); echo $client->responsedata; }...?> Deaktywacja ogłoszenia <?php //przykladowy session-id: 113f4d58048d5dd567f efb9ae $insertion = array('id' => 'C186786'); $parameters = array( "insertion" => $insertion, "session-id"=> "113f4d58048d5dd567f efb9ae", "webapi-key" => "ABCA C079584C1B6C86A791D7" ); //wywolanie metody WebAPI::doDealerInsertionInactivate() $response = $client->call('dodealerinsertioninactivate', $parameters); //wyswietlenie odpowiedzi if($client->fault) { //sprawdzenie czy wystapil blad echo "FAULT: <p>code: {$client->faultcode}<br />"; echo "String: {$client->faultstring}"; } else { header("content-type: text/xml;"); otomoto /25

25 }...?> header("content-length: ".strlen($client->responsedata)); echo $client->responsedata; cykl życia ogłoszenia Po wykonaniu doinsertionedit po raz pierwszy z danym remote-id, lub bez id ogłoszenie staje się natychmiast aktywne, i pozostaje aktywne przez 14 kolejnych dni. Wykonanie w dowolnym momencie metody dodealerinsertionactivate powoduje przedłużenie aktywności ogłoszenia o kolejne 14 oraz doliczenie wystawienia ogłoszenia do licznika wystawień dealera. Przykładowo: jeżeli dnia zostanie dodane ogłoszenie poprzez doinsertionedit to będzie ono aktywne przez najbliższe 14 dni do Jeżeli następnego dnia (20.11) zostanie wykonana metoda dodealerinsertionactivate, to ogłoszenie zostanie przedłużone o 14 dni, czyli do Aby zachować ciągłość wyświetlania ogłoszenia wystarczy wysyłać dodealerinsertionactivate raz na 14 dni. Jeżeli w ciągu 35 dni od daty deaktywacji ogłoszenia nie nastąpi jego aktywacja, to zostanie ono usunięte. Aby deaktywować ogłoszenie szybciej niż po 14 dniach należy skorzystać z metody dodealerinsertioninactivate, lub usunąć ogłoszenie metodą doinsertiondelete. otomoto /25