REST API synchronizace | OneCore Docs

Jedná se o synchronizaci dat týkajících se vozidel a ceníků pneuservisu. Přenáší se následující entity:

CarMake - značky vozidel
CarModelLine - modelové řady
CarModel - modely vozidel
CarClass - třídy vozidel
FuelType - typy paliva
Gearbox - typy převodovek
Catalogue – katalog
Tire - ceník pneumatik
Rim - ceník ráfků
TireChangePricelist - ceník přezutí pneumatik
TireStorePricelist - ceník skladování pneumatik

Při importu se existující záznamy v cenících TireChangePricelist a TireStorePricelist nahradí vždy celé. Ostatní entity se párují dle atributu ExternalId. Když se nalezne záznam se stejným ExternalId, tak se obnoví. Pokud je v externí API nový záznam, tak se přidá do kalkulátoru. U všech záznamů, které se již v externí API nenaleznou, se nastaví příznak IsDeleted na true v kalkulátoru.

V dalších kapitolách jsou popsány vstupy a výstupy k jednotlivým integracím.

Obecné technické parametry

Rest API je nutná naimplementovat na straně zákazníka tak, aby vyhovovala datové struktuře popsané níže. API očekává endpointy ve formátu /api/seyfor/{entityName} tzn. např. /api/seyfor/catalogue. Vše jsou POST requesty.

Tyto endpointy pravidelně volá synchronizační modul a následně je importuje do naší databáze.

Autorizace

Aktuálně je podporována Basic Authentication

API – catalogue

Vstupy:

@market - char(2) – Market

Výstupy:

Volání vrátí všechny katalogové záznamy pro daný market. Na pozadí tato data rozdělujeme do tabulek CarMake, CarModelLine, CarModel a Catalogue.

Properties – CarMake, CarModelLine, CarModel, Catalogue:	Poznámka
CarMakeExternalId	nvarchar Párovací ID značky auta
CarModelLineExternalId	nvarchar Párovací ID modelové řady automobilů
CarMakeName	nvarchar Název značky auta
CarModelLineName	Nvarchar Název modelové řady automobilů
CarModelExternalId	Nvarchar Párovací ID modelu auta
CarModelName	Nvarchar Název modelu auta
CarModelSalesFrom	DateTime NULLABLE Od kdy je prodávané
CarModelSalesTo	DateTime NULLABLE Do kdy je prodávané
CatalogueExternalId	Nvarchar Párovací ID konkrétního automobilu
CatalogueName	Nvarchar Název automobilu
CatalogueEngineKw	Int
CatalogueFuelType	Nvarchar Párovací ID typu pohonu z číselníku FuelType
CatalogueEngineCcm	Int
CatalogueGearbox	Nvarchar Párovací ID typu pohonu z číselníku GearBox
CatalogueTotalWeightKg	Int Váha
CatalogueCarClass	Nvarchar Párovací ID typu pohonu z číselníku CarClass
CarModelCarTypeExternal	Nvarchar Typ vozidla Možné hodnoty: Car Truck

API – tyres

Vstupy:

@market - char(2)

Výstupy:

Vrátí všechny záznamy pneumatik.

Properties - Tire:	Poznámka
ExternalId	Nvarchar Párovací ID
VendorMake	Nvarchar Výrobce
Season	Nvarchar Roční období Možné hodnoty: · Summer · Winter · AllSeason
Type	Nvarchar Typ pneumatiky Možné hodnoty: Personal Suv Van
Width	Decimal Šířka
Profile	Decimal Profil
Diameter	Int Průměr
Pattern	Nvarchar Vzorek
Load_Index	Nvarchar Index zatížení
Speed_Index	Nvarchar Rychlostní index
XL	Bit Jedná se o XL?
RunFlat	Bit Má příznak run-flat?
Comment	Nvarchar Komentář
PriceExclVAT	Decimal Cena bez DPH
Cargo	Bit Je pro náklad?
Category	Nvarchar Kategorie pneumatiky Možné hodnoty: Basic Medium Premium

API – rims

Vstupy:

@market - char(2) - povinný, default ‘CZ ‘

Výstupy:

Vrátí všechny záznamy ráfků.

Properties - Rim:	Poznámka
ExternalId	Nvarchar Párovací Id
Make	Nvarchar Značka
Type	Nvarchar Typ ráfku
Design	Nvarchar Design
Width	Decimal Šířka
Diameter	Int Průměr
Comment	Nvarchar Komentář
PriceExclVAT	Decimal Cena bez DPH

API – carclass

Vstupy:

@market - char(2) – Market

Výstupy:

Vrátí všechny záznamy třid vozidel.

Properties - CarClass:

Poznámka

ExternalId

Nvarchar

Párovací ID

Name

Nvarchar

Název

API – gearbox

Vstupy:

@market - char(2) – Market

Výstupy:

Vrátí všechny záznamy převodovek.

Properties – GearBox:

Poznámka

ExternalId

Nvarchar

Párovací ID

Name

Nvarchar

Název

API – fueltype

Vstupy:

@market - char(2) – Market

Výstupy:

Vrátí všechny záznamy typů paliv.

Properties – FuelType:

Poznámka

ExternalId

Nvarchar

Párovací ID

Name

Nvarchar

Název

API – tyres_change

Vstupy:

@market - char(2) – Market

ChangeType možné hodnoty:

Tires
Wheels

Výstupy:

Vrátí všechny záznamy ceníku výměny pneumatik.

Properties - TireChangePricelist:	Poznámka
Market	Char(2) Kód země Možné hodnoty: CZ SK
Category	Nvarchar Kategorie Možné hodnoty: · Standard · TPMS · RunFlat · RunFlat+TPMS · 4x4/SUV · SUV · 4x4 · VAN · Runflat+SUV · SUVRunFlat
TireChangeType	Nvarchar Typ výměny Možné hodnoty: TireChange WheelChange
RimDiameterFrom	Int Nullable Průměr ráfku od
RimDiameterTo	Int Nullable Průměr ráfku do
PriceExclVAT	Cena bez DPH

API – tyres_store

Vstupy:

@market - char(2) – Market

Výstupy:

Vrátí všechny záznamy ceníku výměny pneumatik.

Properties- TireStoragePricelist:
Market	Char(2) Kód země Možné hodnoty: CZ SK
Type	Možné hodnoty: · TireChange · WheelChange
RimDiameterFrom	Int Nullable Průměr ráfku od
RimDiameterTo	Int Nullable Průměr ráfku do
PriceExclVAT	Cena bez DPH