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

Ez az oldal egy régebbi verziója. Nézze meg a jelenlegi verziót.

Összehasonlítás a jelenlegivel Korábbi változatok megtekintése

1 verzió Tovább »

A DbConnector alkalmazáshoz kapcsolódó API felületen keresztül a SUP® néhány törzsadatállománya is hozzáférhető intranetes webszolgáltatásként.
A webszolgáltatás XML alapú REST API kezelési móddal érhető el.

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

POST | GET
   http://server/dbconnector/api/torzs     

 

Az egyes törzsadatok elérése az innen nyíló al-verbeken érhetők el.  A válaszok XML-ben érkeznek.

Minden API híváskor az autentikációs adatokat a HTTP header-ben kell beküldeni.

Header paraméterek
   pkod:SajatSupPartnerKod
   lickod:SajatSupLicKod 

Az adatok a SUP rendszert felhasználó cég számára átadott licence adatlapon találhatók.

  • pkod - SUP partnerkód
  • lickod - SUP licence kód

További header paraméter

   cegkod:SupCegkod

A cégkódot az API-t üzemeltető cég adja meg. A SUP® rendszerben a Szerviz | Könyvelt cégek menüpontból olvasható ki.

Az egyes verb-eknél további header paraméterek átadása is szükséges lehet.

Tartalom

API tesztelése

Az API elérhetőségének tesztelése a DbConnector REST API - számla dokumentációs oldalon érhető el.
Az dokumentációban az API műveletek bemutatására a széles körben elterjedt CURL segítségével történik.

Partnertörzs

Partnerek listája

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

GET
    http://server/dbconnector/api/torzs/partner

Paraméter
   További header paraméterek nem szükségesek

Result
   XML - <ResultList> : A partnerkódok listája vesszővel elválasztva.

Hívás minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner  ^
  -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: 'partner kódok' Cégkód: 'CEGKOD'</Message>
    <ResultList>0001,0002,0003,0004,0005,0006,0007,0008,0009,0010</ResultList>
    <ResultListCnt>10</ResultListCnt>
</DbConnectorResponse>

Egy partner részletes adatai

Az előző verb-en lekért partnerkódok listája alapján egy partner részletes adatai kérdezhetők le.

GET
    http://server/dbconnector/api/torzs/partner/{PartnerKod}

Paraméter (kötelező)
     format:default cégfüggő implementáció. A formátum (adattartalom) az API-t használó kliens programhoz igazodva kerül implementálásra.

Result
   XML - <Partner> : Egy partner részletes adatai.

Hívás minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner/0001  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod             ^
  -H format:default
Válasz minta
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
  <Message>Not Implemented API verb - fejlesztés alatt</Message>
</DbConnectorResponse>

Partnerek részletes adatai tömbként

Kevés számú partner esetén alkalmazható, a partnerek részletes adatainak XML tömbként történő lekérdezése.

GET
    http://server/dbconnector/api/torzs/partner

Paraméter (kötelező)
     format:default cégfüggő implementáció. A formátum (adattartalom) az API-t használó kliens programhoz igazodva kerül implementálásra.

Result
   XML - <ResultList> : Partnerek részletes adatai XML tömbként.

Hívás minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod             ^
  -H format:default
Válasz minta
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
    <Success>true</Success>
    <StatusCode>200</StatusCode>
    <ResultListCnt>3</ResultListCnt>
    <Partnerek version="PTD_1.0">
        <Partner>
            <PartnerKod>ALL001</PartnerKod>
            <PartnerRovnev>Allianz Hungária</PartnerRovnev>
            <PartnerNev>Allianz Hungária</PartnerNev>
            <Adoszam/>
            <orszagKod/>
            <cimIrsz>1054</cimIrsz>
            <cimVaros>Budapest</cimVaros>
            <cimUtca>Bajcsy Zs. 52.</cimUtca>
        </Partner>
        <Partner>
            <PartnerKod>ATL001</PartnerKod>
            <PartnerRovnev>Atlanta Kft.</PartnerRovnev>
            <PartnerNev>Atlanta Kft.</PartnerNev>
            <Adoszam>10557390241</Adoszam>
            <orszagKod/>
            <cimIrsz>1118</cimIrsz>
            <cimVaros>Budapest</cimVaros>
            <cimUtca>Budaörsi út 765.</cimUtca>
        </Partner>
        <Partner>
            <PartnerKod>AUT001</PartnerKod>
            <PartnerRovnev>Autópálya Zrt.</PartnerRovnev>
            <PartnerNev>Autópálya Zrt.</PartnerNev>
            <Adoszam/>
            <orszagKod/>
            <cimIrsz>1031</cimIrsz>
            <cimVaros>Budapest</cimVaros>
            <cimUtca>Lövedék utca 2.</cimUtca>
        </Partner>
    </Partnerek>
</DbConnectorResponse>

Partner keresés adótörzsszám szerint

A partnerkód mellett, más lekérdezési szempont szerint is lekérdezhető a partnertörzs. Ilyen pl.: az adótörzsszám.

GET
    http://server/dbconnector/api/torzs/partner?adotorzs=12345678

Paraméter (kötelező)
     format:default cégfüggő implementáció. A formátum (adattartalom) az API-t használó kliens programhoz igazodva kerül implementálásra.

Result
   XML - <Partner> : A kért partner részletes adatai.

Hívás minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner?adotorzs=10895797  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod             ^
  -H format:default
Válasz minta
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
    <Success>true</Success>
    <StatusCode>200</StatusCode>
    <Partnerek version="PTD_1.0">
        <Partner>
            <PartnerKod>QSOFT</PartnerKod>
            <PartnerRovnev>QSoft Kft.</PartnerRovnev>
            <PartnerNev>QSoft Számítástechnikai és Ügyviteli Szolgáltató Kft.</PartnerNev>
            <Adoszam>10895797243</Adoszam>
            <cimIrsz>1119</cimIrsz>
            <cimVaros>Budapest</cimVaros>
            <cimUtca>Fehérvári út 85.</cimUtca>
        </Partner>
    </Partnerek>
</DbConnectorResponse>

Partner keresés megnevezés szerint

További lekérdezési szempont a partner neve.

GET
    http://server/dbconnector/api/torzs/partner?megnev=Cégnév

Paraméter (kötelező)
     format:default cégfüggő implementáció. A formátum (adattartalom) az API-t használó kliens programhoz igazodva kerül implementálásra.

Result
   XML - <Partnerek> : A lekérdezés több rekordot is adhat eredményül.

Hívás minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner?megnev=Magyar  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod             ^
  -H format:default
Válasz minta
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
    <Success>true</Success>
    <StatusCode>200</StatusCode>
    <ResultListCnt>2</ResultListCnt>
    <Partnerek version="PTD_1.0">
        <Partner>
            <PartnerKod>MAG002</PartnerKod>
            <PartnerRovnev>Magyar Posta Zrt.</PartnerRovnev>
            <PartnerNev>Magyar Posta Zrt.</PartnerNev>
            <Adoszam/>
            <cimIrsz>1063</cimIrsz>
            <cimVaros>Budapest</cimVaros>
            <cimUtca>Virág u. 10.</cimUtca>
        </Partner>
        <Partner>
            <PartnerKod>TEL001</PartnerKod>
            <PartnerRovnev>Telenor</PartnerRovnev>
            <PartnerNev>Telenor Magyarország Zrt.</PartnerNev>
            <Adoszam/>
            <cimIrsz>2040</cimIrsz>
            <cimVaros>Budaörs</cimVaros>
            <cimUtca>Baross u. 165</cimUtca>
        </Partner>
    </Partnerek>
</DbConnectorResponse>

Partner keresés bankszámlaszám szerint

További lekérdezési szempont a partner(ek) bankszámlaszáma.

GET
    http://server/dbconnector/api/torzs/partner?bankszla=1090009912345678

Paraméter (kötelező)
     format:default cégfüggő implementáció. A formátum (adattartalom) az API-t használó kliens programhoz igazodva kerül implementálásra.

Result
   XML - <ResultList> : A lekérdezés több rekordot is adhat eredményül.

Hívás minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner?bankszla=1090009912345678   ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod             ^
  -H format:default
Válasz minta
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
    <Success>true</Success>
    <StatusCode>200</StatusCode>
    <Partnerek version="PTD_1.0">
        <Partner>
            <PartnerKod>TET001</PartnerKod>
            <PartnerRovnev>Tételes ÁFA Kft.</PartnerRovnev>
            <PartnerNev>Tételes ÁFA Kft.</PartnerNev>
            <Adoszam/>
            <cimIrsz>1111</cimIrsz>
            <cimVaros>Budapest</cimVaros>
            <cimUtca>Zöld u. 11.</cimUtca>
        </Partner>
    </Partnerek>
</DbConnectorResponse>

Cikktörzs

Cikkek listája

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

GET

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

Paraméter (kötelező)
   További header paraméterek nem szükségesek

Result
   XML - <ResultList> : A cikkkódok listája vesszővel elválasztva.

Hívá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>    
    <ResultList>0001,0002,0003,0004,0005,0006,0007,0008,0009,0010</ResultList>
    <ResultListCnt>10</ResultListCnt>
</DbConnectorResponse>

Egy cikk részletes adatai

Az előző verb-en lekért cikkkódok listája alapján egy cikk részletes adatai kérdezhetők le.

GET
    http://server/dbconnector/api/torzs/cikk/{CikkKod}

Paraméter (kötelező)
   format:listaar cégfüggő implementáció. A formátum (adattartalom) az API-t használó kliens programhoz igazodva kerül implementálásra.

Result
   XML - <Cikk> : Egy cikk részletes adatai.

 

Hívás minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/cikk/0001  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod
  -H format:listaar
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>
            <EgysarNetto>4520</EgysarNetto>
            <SzabadKeszlet>11</SzabadKeszlet>
            <Megys>db</Megys>
        </Cikk>
    </Cikkek>
</DbConnectorResponse>

Cikkek részletes adatai tömbként

Kis méretű 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

Paraméter (kötelező)
   format:listaar cégfüggő implementáció. A formátum (adattartalom) az API-t használó kliens programhoz igazodva kerül implementálásra.

Result
   XML - <Cikkek> : Cikkek részletes adatai XML tömbként.

Hívás minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/cikk  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod
  -H format:listaar
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>
            <EgysarNetto>4520</EgysarNetto>
            <SzabadKeszlet>11</SzabadKeszlet>
            <Megys>db</Megys>
        </Cikk>
        <Cikk>
            <CikkKod>0002</CikkKod>
            <CikkNev>Infrared Micro Switch gaming mouse - White</CikkNev>
            <EanKod>4711421868334</EanKod>
            <EgysarNetto>3900</EgysarNetto>
            <SzabadKeszlet>11</SzabadKeszlet>
            <Megys>db</Megys>
        </Cikk>
        <Cikk>
            <CikkKod>0003</CikkKod>
            <CikkNev>Infrared Micro Switch gaming mouse - Blue</CikkNev>
            <EanKod>4711421876735</EanKod>
            <EgysarNetto>3900</EgysarNetto>
            <SzabadKeszlet>9</SzabadKeszlet>
            <Megys>db</Megys>
        </Cikk>
    </Cikkek>
</DbConnectorResponse>

Gyűjtő csoportok és azonosítók

A SUP® rendszerben a feldolgozás során használt analitikus kódok (gyűjtők, dimenziók, és további elnevezések is léteznek más rendszerekben) egységesen gyűjtő csoport - gyűjtő azonosító szerkezetben vannak tárolva.
A gyűjtő csoport az adott analitikus csoport (dimenzió) neve (pl.: költséghely, munkaszám, gépkocsi rendszám, stb.). A gyűjtő azonosító pedig az egyes gyűjtő csoportokon belül használható kódok listája. (pl.: munkaszám kódok). A REST API ezt a logikát követi.

Gyűjtő csoportok lekérdezése

A gyűjtő csoportok kis számossága miatt az általános REST API konvenciót megtörve, nem a <ResultList> adattagon adja vissza a a gyűjtő csoportok listáját, hanem közvetlenül XML tömbként.

GET

    http://server/dbconnector/api/torzs/gyujtok

Paraméter (kötelező)
   További header paraméterek nem szükségesek

Result
   XML - <GyCsop> : A gyűjtő csoportok adatai XML tömbként.

Hívás minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/gyujtok  ^
  -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>4</ResultListCnt>
    <GyCsopList version="GTC_1.0">
        <GyCsop>
            <GyCsopKod>0001</GyCsopKod>
            <Megnev>Költséghelyek</Megnev>
            <Tipus>KTH</Tipus>
        </GyCsop>
        <GyCsop>
            <GyCsopKod>0005</GyCsopKod>
            <Megnev>Dolgozók</Megnev>
            <Tipus>DLG</Tipus>
            <UiKod/>
        </GyCsop>
        <GyCsop>
            <GyCsopKod>0006</GyCsopKod>
            <Megnev>Telefonok</Megnev>
            <Tipus>N</Tipus>
        </GyCsop>
        <GyCsop>
            <GyCsopKod>0007</GyCsopKod>
            <Megnev>Gépkocsik</Megnev>
            <Tipus>N</Tipus>
        </GyCsop>
    </GyCsopList>
</DbConnectorResponse>
 Megjegyzés

A SUP® rendszerben a gyűjtő csoportokat a <GyCsopKod> azonosítja. Vannak viszont úgynevezett kiemelt gyűjtő csoport típusok. Ezek esetében a gyűjtő csoport kódja helyett az URL-ben a kiemelt gyűjtőcsoportot azonosító ENUM is szerepelhet. A gyűjtő csoport kódok adatbázisonként eltérhetnek, a kiemelt gyűjtő csoportok ENUM lista viszont adatbázis-független.
A kiemelt gyűjtő csoport típusok listája a következő:
        OEL - Önelszámoló egység
        KTH - Költséghely
        MSZ - Munkaszám
        PLY - Pályázat
        DLG - Dolgozó
        UZK - Üzletkötő
        POZ - Pozíciószám
        PRT - Partner

Egy gyűjtő csoport lekérdezése - gyűjtő azonosítók listája

Egy gyűjtő csoport részletes adatai a következő verb-en érhető el. A gyűjtő csoport részletes adatai tartalmazzák <ResultList> adatként a csoporton belüli azonosítók listáját..

GET

    http://server/dbconnector/api/torzs/gyujtok/{GyCsopKod}
    http://server/dbconnector/api/torzs/gyujtok/{ENUM}

Paraméter (kötelező)
   További header paraméterek nem szükségesek

Result
   XML - <GyCsop> : A gyűjtő csoportok adatai XML tömbként.

Hívás minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/gyujtok/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>
    <GyCsop>
        <GyCsopKod>0001</GyCsopKod>
        <Megnev>Ktgh</Megnev>
        <Tipus>KTH</Tipus>
        <GyAzonKodList>01,02,03,04</GyAzonKodList>
    </GyCsop>
</DbConnectorResponse>

Egy gyűjtő azonosító lekérdezése

Egy gyűjtő azonosító részletes adatai a következő verb-en érhető el. .

GET

    http://server/dbconnector/api/torzs/gyujtok/{GyCsopKod}/{GyAzonKod}
    http://server/dbconnector/api/torzs/gyujtok/{ENUM}/{GyAzonKod}

Paraméter (kötelező)
   További header paraméterek nem szükségesek

Result
   XML - <GyCsop> : A gyűjtő csoportok adatai XML tömbként.

Hívás minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/gyujtok/0001/01  ^
  -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>
    <GyAzon>
        <GyAzonKod>01</GyAzonKod>
        <Megnev>Központ</Megnev>
    </GyAzon>
</DbConnectorResponse>

Gyűjtő csoport adatainak frissítése

Gyűjtő azonosító adatainak frissítése