Kapcsolódó információk:
› Paraméterezési útmutatók

A DbConnector REST API felületen keresztül a SUP® cikktörzs állománya is hozzáférhető intranetes webszolgáltatásként.
A webszolgáltatás XML alapú REST API hívásokkal működtethető.

Az API a következő belépési ponton érhető el. A szerver név a helyi intranetet környezettől függ.

A válaszok XML-ben érkeznek.

A REST API hívások általános használata a DbConnector REST API oldalon található.

GET

http://server/dbconnector/api/torzs/cikk

Header paraméterek: az API használathoz szükséges pkod, lickod, cegkod paraméterek.

További paraméter: a lekérdezéstől függően


A cikktörzs adatok lekérdezésre a következő lehetőségek vannak

Cikkszámok listája

A SUP® rendszer cikktörzs állománya a következő verb-en érhető el.

GET

http://server/dbconnector/api/torzs/cikk

Query paraméter: nincs

Result: a cikk kódok listája vesszővel elválasztva.

Kérés minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/cikk  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod
Válasz minta
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
    <Success>true</Success>
    <StatusCode>200</StatusCode>
    <Message>Törzsadat: 'cikkszámok' Cégkód: 'CEGKOD'</Message>    
	<ResultListCnt>10</ResultListCnt>
    <ResultList>0001,0002,0003,0004,0005,0006,0007,0008,0009,0010</ResultList>
</DbConnectorResponse>

Egy cikk részletes adatai

Az előző verb-en lekért cikk kódok listája alapján, egy cikk részletes adatai kérdezhetők le. A lekérdezésben a cikktörzs default formátuma van dokumentálva. Lehetőség van cégfüggő formátumok implementálására is.

GET

http://server/dbconnector/api/torzs/cikk/{cikkkod}

További paraméter:

  • format:listaar opcionális paraméter, és cégfüggő implementáció. A formátum (adattartalom) az API-t használó kliens programhoz igazodva kerül implementálásra.

Result: a cikk részletes adatai.

Kérés minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/cikk/0001  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod
Válasz minta
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
  <Success>true</Success>
  <StatusCode>200</StatusCode>
  <ResultListCnt>1</ResultListCnt>
  <Cikkek>
    <Cikk>
      <CikkKod>0001</CikkKod>
      <CikkNev>Infrared Micro Switch gaming mouse - Black</CikkNev>
      <EanKod>4711421917827</EanKod>
      <Megys>db</Megys> 
      <Ervenyes>true</Ervenyes>
    </Cikk>
  </Cikkek>
</DbConnectorResponse>

Cikkek részletes adatai tömbként

Kis tételszámú cikktörzs esetén alkalmazható, a cikkek részletes adatainak tömbként történő lekérdezése.

GET

http://server/dbconnector/api/torzs/cikk

Header paraméterek: az API használathoz szükséges pkod, lickod, cegkod paraméterek.

Paraméter:

  • format:array a paraméter megadása esetén nem csak a cikk kódok listája, hanem minden cikk részletes adatai benne lesznek a lekérdezésben, XML tömbként.

Result: cikk részletes adatai XML tömbként.

Kérés minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/cikk  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod
  -H format:array
Válasz minta
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
  <Success>true</Success>
  <StatusCode>200</StatusCode>
  <ResultListCnt>3</ResultListCnt>
  <Cikkek>
    <Cikk>
      <CikkKod>0001</CikkKod>
      <CikkNev>Infrared Micro Switch gaming mouse - Black</CikkNev>
      <EanKod>4711421917827</EanKod>
      <Megys>db</Megys>
      <EgysarNetto>4520</EgysarNetto>
      <SzabadKeszlet>11</SzabadKeszlet>
    </Cikk>
    <Cikk>
      <CikkKod>0002</CikkKod>
      <CikkNev>Infrared Micro Switch gaming mouse - White</CikkNev>
      <EanKod>4711421868334</EanKod>
      <Megys>db</Megys>
      <Ervenyes>true</Ervenyes> 
    </Cikk>
    <Cikk>
      <CikkKod>0003</CikkKod>
      <CikkNev>Infrared Micro Switch gaming mouse - Blue</CikkNev>
      <EanKod>4711421876735</EanKod>
      <Megys>db</Megys>       
      <Ervenyes>true</Ervenyes> 
    </Cikk>
  </Cikkek>
</DbConnectorResponse>

Cikkek keresése változás dátuma szerint

A partner rekordok lekédezhetők a felvitel, vagy utolsó változás dátum szerint. A felvitel szerinti lekérdezés csak az adott dátum után felvitt partnereket mutatja. A változás dátum szerinti lekérdezés a módosított, és az újként felvitt partner adatokat is tartalmazza.

GET

http://server/dbconnector/api/torzs/cikk?changed=2021-01-12
http://server/dbconnector/api/torzs/cikk?new=2021-01-1

Paraméter:

  • changed=2021-01-12  az adott dátum óta megváltozott vagy újként felvitt cikkek
  • new=2021-01-1  az adott dátum óta újként felvitt cikkek

Result: partnerek részletes adatai XML tömbként.

Kérés minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner?changed=2021-01-12   ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod
Válasz minta
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
  <Success>true</Success>
  <StatusCode>200</StatusCode>
  <ResultListCnt>3</ResultListCnt>
  <Cikkek>
    <Cikk>
      <CikkKod>0004</CikkKod>
      <CikkNev>Infrared Micro Switch gaming mouse - Yellow</CikkNev>
      <EanKod>4711421876735</EanKod>
      <Megys>db</Megys>       
      <Ervenyes>false</Ervenyes> 
    </Cikk>
  </Cikkek>
</DbConnectorResponse>

 Megjegyzés

Szorosabb integráció esetén az API-n keresztül ú.n. webes callback értesítést tudunk küldeni a cikk adatok változásáról. Ez alapján a megváltozott cikk rekord azonnal lekérdezhető, és szinkronizálható.