OneCore Docs
Breadcrumbs

Sync REST API

It is a synchronization of data related to vehicles and tire service price lists. The following entities are transferred:

  • CarMake - Vehicle Brands

  • CarModelLine - model lines

  • CarModel - Vehicle Models

  • CarClass - Vehicle Classes

  • FuelType - fuel types

  • Gearbox - Types of Gearboxes

  • Catalogue

  • Tire - tire price list

  • Rim - Rim Pricelist

  • TireChangePricelist - tire change price list

  • TireStorePricelist - tire storage price list

When importing, existing records are not included in the price lists TireChangePricelist and TireStorePricelist It always replaces the whole thing. Other entities are matched by attribute ExternalId. When a record with the same ExternalId, so it will recover. If there is a new record in the external API, it will be added to the calculator. For all records that are no longer found in the external API, the flag is set IsDeleted on true in the calculator.

In the following chapters, the inputs and outputs to individual integrations are described.

General Technical Parameters

The REST API must be implemented on the customer's side so that it fits the data structure described below. The API expects endpoints in the format /api/seyfor/{entityName}, e.g. /api/seyfor/catalogue. These are all POST requests.

These endpoints are regularly called by the synchronization engine and then imported into our database.


Authorization

Currently supported Basic Authentication


API – catalogue

Inputs:

  • @market - char(2) – Market


Outputs:

The call returns all catalog records for that market. In the background, we divide this data into CarMake, CarModelLine, CarModel, and Catalogue tables.


Properties – CarMake, CarModelLine, CarModel, Catalogue:

Note

CarMakeExternalId

nvarchar

Car Make Pairing ID

CarModelLineExternalId

nvarchar

Car Model Line Matching ID

CarMakeName

nvarchar

Car Make Name

CarModelLineName

Nvarchar

Car Model Line Name

CarModelExternalId

Nvarchar

Car Model Pairing ID

CarModelName

Nvarchar

Car Model Name

CarModelSalesFrom

DateTime NULLABLE

Since when is it sold?

CarModelSalesTo

DateTime NULLABLE

Until when it is sold

CatalogueExternalId

Nvarchar

Pairing ID of a specific car

CatalogueName

Nvarchar

Car Name

CatalogueEngineKw

Int

CatalogueFuelType

Nvarchar

Powertrain Type Pairing ID from the FuelType dial

CatalogueEngineCcm

Int

CatalogueGearbox

Nvarchar

Powertrain Type Pairing ID from the GearBox dial

CatalogueTotalWeightKg

Int

Weight

CatalogueCarClass

Nvarchar

Powertrain Type Pairing ID from the CarClass dial

CarModelCarTypeExternal

Nvarchar

Vehicle Type

Possible values:

  • Tsar

  • Truck


API – tyres

Inputs:

  • @market - char(2)

Outputs:

Returns all tire records.


Properties - Tire:

Note

ExternalId

Nvarchar

Pairing ID

VendorMake

Nvarchar

Producer

Season

Nvarchar

Season

Possible values:

·         Summer

·         Winter

·         AllSeason

 

Type

Nvarchar

Tyre Type

Possible values:

  • Staff

  • SUV

  • Van

Width

Decimal

Width

Profile

Decimal

Profile

Diameter

Int

Diameter

Pattern

Nvarchar

Sample

Load_Index

Nvarchar

Load Index

Speed_Index

Nvarchar

Speed Index

XL

Bit

Is it XL?

RunFlat

Bit

Does it have a run-flat flag?

Comment

Nvarchar

Comment

PriceExclVAT

Decimal

Price Excl. VAT

Cargo

Bit

Is it for cargo?

Category

Nvarchar

Tire Category

Possible values:

  • Basic

  • Medium

  • Premium



API – ledges

Inputs:

  • @market - char(2) - required, default 'CZ'

Outputs:

Returns all rim records.


Properties - Rome:

Note

ExternalId

Nvarchar

Pairing Id

Make

Nvarchar

Make

Type

Nvarchar

Rim Type

Design

Nvarchar

Design

Width

Decimal

Width

Diameter

Int

Diameter

Comment

Nvarchar

Comment

PriceExclVAT

Decimal

Price Excl. VAT


API – carclass

Inputs:

  • @market - char(2) – Market

Outputs:

Returns all vehicle class records.


Properties - CarClass:

Note

ExternalId

Nvarchar

Pairing ID

Name

Nvarchar

Title


API – gearbox

Inputs:

  • @market - char(2) – Market

Outputs:

Returns all transmission records.


Properties – GearBox:

Note

ExternalId

Nvarchar

Pairing ID

Name

Nvarchar

Title





API – fueltype

Inputs:

  • @market - char(2) – Market

Outputs:

Returns all fuel type records.


Properties – FuelType:

Note

ExternalId

Nvarchar

Pairing ID

Name

Nvarchar

Title


API – tyres_change

Inputs:

  • @market - char(2) – Market

ChangeType possible values:

  • Tires

  • Wheels

Outputs:

Returns all records of the tire replacement price list.


Properties - TireChangePricelist:

Note

Market

Char(2)

Country Code

Possible values:

  • CZ

  • SK

Category

Nvarchar

Category

Possible values:

·         Standard

·         TPMS

·         RunFlat

·         RunFlat+TPMS

·         4x4/SUV

·         SUV

·         4x4

·         VAN

·         Runflat+SUV

·         SUVRunFlat


TireChangeType

Nvarchar

Replacement Type

Possible values:

  • TireChange

  • WheelChange

RimDiameterFrom

Int Nullable

Rim Diameter From

RimDiameterTo

Int Nullable

Rim diameter to

PriceExclVAT

Price Excl. VAT


API – tyres_store

Inputs:

  • @market - char(2) – Market

Outputs:

Returns all records of the tire replacement price list.


Properties- TireStoragePricelist:


Market

Char(2)

Country Code

Possible values:

  • CZ

  • SK

Type

Possible values:

·         TireChange

·         WheelChange


RimDiameterFrom

Int Nullable

Rim Diameter From

RimDiameterTo

Int Nullable

Rim diameter to

PriceExclVAT

Price Excl. VAT