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

Korábbi változatok

Összehasonlított verziók

Régi verzió 2

changes.mady.by.user QSoft

Mentés ekkor: '2021 jan. 17, ' típus

összehasonlítva

Új verzió Aktuális

changes.mady.by.user QSoft

Mentés ekkor: '2022 máj. 26, ' típus

Kulcs

Beillesztett sor.
Törölt sor.
Formázás megváltoztatva.

A DbConnector REST API felületen keresztül a SUP^® partnertö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ő.

...

width	50%

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ó.

...

BeigeTartalom

Panel

bgColor

AliceBlue

titleBGColor

Tartalomjegyzék

maxLevel	2

Partner kódok listája

...

LightSteelBlue
title	GET

...

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

...

parner

Header paraméterek: az API használathoz szükséges pkod, lickod, cegkod paraméterek.
További paraméterek: a lekérdezéstől függően

A partner törzs lekérdezésre a következő lehetőségek vannak

Tartalomjegyzék

maxLevel	2

Partner kódok listája

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

Panel

bgColor	AliceBlue
titleBGColor	LightSteelBlue
title	GET

http://server/dbconnector/api/torzs/parner

Paraméter: nincs

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

Kódblokk

language	java
title	Kérés minta

CURL.

...

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

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

Kódblokk

language	bash
title	Hívás minta

CURL.

EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod

Kódblokk

language	xml
title	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, partnerkód alapján.

Panel

bgColor	AliceBlue
titleBGColor	LightSteelBlue
title	GET

...

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

...

partnerkod}

Result

...

bashHívás

: a partner részletes adatai.

Kódblokk

language

title
java

Kérés minta

CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner/0001  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod

Kódblokk

language	xml
title	Válasz minta

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>

<Success>true</Success>

  <StatusCode>200</StatusCode>

  <Partnerek version="

PTD

PTDEFAULT_1.

1">

    <Partner>

      <PartnerKod>MAG002</PartnerKod>

      <PartnerRovnev>Magyar Posta Zrt.</PartnerRovnev>

<PartnerNev>Magyar Posta Zrt.</PartnerNev>
      <Adoalany>DOMESTIC</Adoalany>

 <!-- A NAV OSA szerinti ENUM lista  -->

<cimIrsz>1063<

<AdoszamHu>12833625444</

cimIrsz>

AdoszamHu>
      <CsopAdoszHu/>

<cimVaros>Budapest<

<AdoszamEu/

cimVaros>

>
      <OrszagKod/>
      <AfaPenzforg>false</AfaPenzforg>

<cimUtca>Virág

10.<

<Kisadozo>false</

cimUtca>

Kisadozo>

<Devnem/

Partner>

</Partnerek> </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.

...

 <KiszlaFizmod>4</KiszlaFizmod>
      <CimIrsz>1063</CimIrsz>
      <CimVaros>Budapest</CimVaros>
      <CimUtca>Virág u. 10.</CimUtca>
      <LevIrsz>1119</LevIrsz>
      <LevVaros>Budapest</LevVaros>
      <LevUtca>Bélafi út 8.</LevUtca>
      <ElsodlBankszla>12345678-12345678-12345678</ElsodlBankszla>
      <ElsodlKapcsTarto>Balla-Balogh Béla</ElsodlKapcsTarto>
    </Partner>
  </Partnerek>
</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.

Panel

bgColor	AliceBlue
titleBGColor	LightSteelBlue
title	GET

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

Paraméter:

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

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

Qsboxmegjegyz
Nagy partnertörzs esetén a lekérdezés time-ot hibát, vagy egyéb túlcsordulás hibát is okzhat. Csak abban az esetben célszerű használni, ha kisebb partnertörzset kell kezelni.

Kódblokk

language	java
title	Kérés minta

CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod

További header paraméter
format:array A paraméter megadása esetén nem csak a partnerkódok listája, hanem minden partner részletes adatai benne lesznek a lekérdezésben, XML tömbként.

Qsboxmegjegyz
Nagy partnertörzs esetén a lekérdezés time-ot hibát, vagy egyéb túlcsordulás hibát is okzhat. Csak abban az esetben célszerű használni, ha kisebb partnertörzset kell kezelni.

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

Kódblokk

language	bash
title	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:array

Kódblokk

language	xml
title	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>

   ^
  -H format:array

Kódblokk

language	xml
title	Válasz minta

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
  <Success>true</Success>

<PartnerRovnev>Allianz

Hungária<

<StatusCode>200</

PartnerRovnev>

StatusCode>
  <ResultListCnt>3</ResultListCnt>
  <Partnerek version="PTDEFAULT_1.1">
    <Partner>

<PartnerNev>Allianz

Hungária<

<PartnerKod>ALL001</

PartnerNev>

PartnerKod>

<PartnerRovnev>Allianz Hungária</PartnerRovnev>

<PartnerNev>Allianz Hungária</PartnerNev>
      <Adoalany>DOMESTIC</Adoalany>

<cimIrsz>1054<

<Adoszam/

cimIrsz>

>
      <OrszagKod/>

<cimVaros>Budapest<

<CimIrsz>1054</

cimVaros>

CimIrsz>
      <CimVaros>Budapest</CimVaros>

<cimUtca>Bajcsy

<CimUtca>Bajcsy Zs. 52.</

cimUtca>

CimUtca>

</Partner>

<Partner>

<PartnerKod>ATL001</PartnerKod>

<PartnerRovnev>Atlanta Kft.</PartnerRovnev>

      <PartnerNev>Atlanta Kft.</PartnerNev>
      <Adoalany>DOMESTIC</Adoalany>

<Adoszam>10557390241</Adoszam>

<orszagKod

<OrszagKod/>
      <CimIrsz>1118</CimIrsz>

<cimIrsz>1118<

<CimVaros>Budapest</

cimIrsz>

CimVaros>
      <CimUtca>Budaörsi út 765.</CimUtca>

<cimVaros>Budapest<

</

cimVaros>

Partner>
    <Partner>

<cimUtca>Budaörsi út 765.</cimUtca>

<PartnerKod>AUT001</PartnerKod>
      <PartnerRovnev>Autópálya

Zrt.</

Partner>

PartnerRovnev>

<PartnerNev>Autópálya Zrt.</PartnerNev>
      <Adoalany>DOMESTIC</Adoalany>

<PartnerKod>AUT001<

<Adoszam/

PartnerKod>

>
      <OrszagKod/>

<PartnerRovnev>Autópálya Zrt.</PartnerRovnev>

<CimIrsz>1031</CimIrsz>
      <CimVaros>Budapest</CimVaros>
      <CimUtca>Lövedék

<PartnerNev>Autópálya

utca

Zrt

2.</

PartnerNev>

CimUtca>
    </Partner>

<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.

...

</Partnerek>
</DbConnectorResponse>

Partnerek keresése 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.

Panel

bgColor	AliceBlue
titleBGColor	LightSteelBlue
title	GET

http://

...

server/dbconnector/api/torzs/partner?adotorzs=12345678

Paraméter

...

adotorzs=12345678 a cég adótörzsszáma alapján keres.

Result

...

bashHívás

: a partner részletes adatai.

Kódblokk

language

title
java

Kérés minta

CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner?adotorzs=10895797  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod

Kódblokk

language	xml
title	Válasz minta

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>

<Success>true</Success>

  <StatusCode>200</StatusCode>

  <Partnerek version="

PTD

PTDEFAULT_1.

1">

    <Partner>

<PartnerKod>QSOFT</PartnerKod>

      <PartnerRovnev>QSoft Kft.</PartnerRovnev>

      <PartnerNev>QSoft Számítástechnikai és Ügyviteli Szolgáltató Kft.</PartnerNev>
      <Adoalany>DOMESTIC</Adoalany>

  <Adoszam>10895797243</Adoszam>
      <CimIrsz>1119</CimIrsz>

<cimIrsz>1119<

<CimVaros>Budapest</

cimIrsz>

CimVaros>
      <CimUtca>Fehérvári

<cimVaros>Budapest</cimVaros> <cimUtca>Fehérvári út

út 85.</

cimUtca>

CimUtca>

    </Partner>

  </Partnerek>
</DbConnectorResponse>

...

Partnerek keresése megnevezés szerint

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

Panel

bgColor	AliceBlue
titleBGColor	LightSteelBlue
title	GET

...

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

Paraméter

...

bashHívás

megnev=Cégnév A cég megnevezésben levő szótöredék alapján keres

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

Kódblokk

language

title
java

Kérés minta

CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner?megnev=Magyar  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod

Kódblokk

language	xml
title	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>

"PTDEFAULT_1.1">
    <Partner>
        <PartnerKod>MAG002</PartnerKod>
        <PartnerRovnev>Magyar Posta Zrt.</PartnerRovnev>
        <PartnerNev>Magyar Posta Zrt.</PartnerNev>
        <Adoalany>DOMESTIC</Adoalany> 
        <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>
        <Adoalany>DOMESTIC</Adoalany> 
        <Adoszam/>
        <CimIrsz>2040</CimIrsz>
        <CimVaros>Budaörs</CimVaros>
        <CimUtca>Baross u. 165</CimUtca>
      </Partner>
  </Partnerek>
</DbConnectorResponse>

Partnerek keresése e-mail cím szerint

Keresés a partnerhet megadott e-mail cím szerint. Az e-mail cím ez esetben azonosító, nem írható be több e-mail cím vesszővel felsorolva.

Panel

bgColor	AliceBlue
titleBGColor	LightSteelBlue
title	GET

http://server/dbconnector/api/torzs/partner?email=support@qsoft.hu

Query paraméter:

email=support@qsoft.hu keresendő e-mail cím

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

Kódblokk

language	java
title	Kérés minta

CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner?email=support@qsoft.hu   ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod

Kódblokk

language	xml
title	Válasz minta

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
  <Success>true</Success>
  <StatusCode>200</StatusCode>
  <ResultListCnt>1</ResultListCnt>
  <Partnerek version="PTDEFAULT_1.1">
    <Partner>
      <PartnerKod>QSOFT</PartnerKod>

<cimUtca>Virág u. 10

<PartnerRovnev>QSoft Kft.</

cimUtca>

PartnerRovnev>
      <PartnerNev>QSoft

Kft.</

Partner>

PartnerNev>

<Adoalany>DOMESTIC</Adoalany>
      <AdoszamHu>10895797243</AdoszamHu>

<PartnerKod>TEL001<

<AfaPenzforg>false</

PartnerKod>

AfaPenzforg>
      <Kisadozo>false</Kisadozo>

<PartnerRovnev>Telenor<

<Cegjszam>0109268133</

PartnerRovnev>

Cegjszam>
      <KiszlaFizmod>4</KiszlaFizmod>

<PartnerNev>Telenor Magyarország Zrt.</PartnerNev>

<CimIrsz>1119</CimIrsz>
      <CimVaros>Budapest</CimVaros>

<CimUtca>Fehérvári út 85. C.ép. 1.em</CimUtca>

<cimIrsz>2040<

<LevIrsz>1518</

cimIrsz>

LevIrsz>
      <LevVaros>Budapest</LevVaros>

<cimVaros>Budaörs</cimVaros>

<LevUtca>Pf.: 128.</LevUtca>
      <CegEmail>support@qsoft.hu</CegEmail>

<cimUtca>Baross u. 165</cimUtca>

<Ervenyes>true</Ervenyes>
    </Partner>

</

Partner> </Partnerek> </DbConnectorResponse>

...

Partnerek>
</DbConnectorResponse>

Qsboxmegjegyz
A SUP rendszer partnertörzs kezelés nem ellenőriz az e-mail cím egyediségre. A `<ResultListCnt>`adattag alapján ellenőrizhető, hogy a SUP partnertörzsben tárolt e-mail cím alkalmas-e egyedi azonosításra

Partnerek keresése bankszámlaszám szerint

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

Panel

bgColor	AliceBlue
titleBGColor	LightSteelBlue
title	GET

...

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

Paraméter

...

bankszla=1090009912345678 A cég bankszámlaszámai alapján keres. Szótöredék használat is lehetséges, a bankszámlaszámot kötőjelek nélkül kell megadni.

Result

...

bashHívás

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

Kódblokk

language

title
java

Kérés minta

CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner?bankszla=1090009912345678   ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod

Kódblokk

language	xml
title	Válasz minta

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>

  <Success>true</Success>

<StatusCode>200</StatusCode>

  <Partnerek version="

PTD

PTDEFAULT_1.

1">

<Partner>

        <PartnerKod>TET001</PartnerKod>

        <PartnerRovnev>Tételes ÁFA Kft.</PartnerRovnev>

        <PartnerNev>Tételes ÁFA Kft.</PartnerNev>
        <Adoalany>DOMESTIC</Adoalany>

    <Adoszam>12345678</Adoszam>

<cimIrsz>1111<

<CimIrsz>1111</

cimIrsz>

CimIrsz>

<cimVaros>Budapest</cimVaros>

<CimVaros>Budapest</CimVaros>

<cimUtca>Zöld

<CimUtca>Zöld u. 11.</

cimUtca>

CimUtca>

</Partner>

</Partnerek>
</DbConnectorResponse>

...

Partnerek keresése partnercsoport szerint

További lekérdezési szempont a partner(ek) SUP-ban nyilvántartott partnercsoport szerinti lekérdezés.

Panel

bgColor	AliceBlue
titleBGColor	LightSteelBlue
title	GET

...

http://server/dbconnector/api/torzs/partner?pcsop=1

Paraméter

...

pcsop=1 A SUP rendszerben használható 1-8 intervallumban megadható partnercsoport besorolás alapján keres. Ettől eltérő intervallum megadása esetén hibaüzenet az eredmény.

Result

...

bashHívás

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

Kódblokk

language

title
java

Kérés minta

CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner?pcsop=1   ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod

Kódblokk

language	xml
title	Válasz minta

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>

  <Success>true</Success>

  <StatusCode>200</StatusCode>

  <Partnerek version="

PTD

PTDEFAULT_1.

1">

<Partner>

<PartnerKod>TET001</PartnerKod>

<PartnerRovnev>Tételes ÁFA Kft.</PartnerRovnev>

<PartnerNev>Tételes ÁFA Kft.</PartnerNev>
      <Adoalany>DOMESTIC</Adoalany>

 <Adoszam>12345678</Adoszam>

<CimIrsz>1111</CimIrsz>

<cimVaros>Budapest</cimVaros>

<CimVaros>Budapest</CimVaros>

<cimUtca>Zöld

<CimUtca>Zöld u. 11.</

cimUtca>

CimUtca>

</Partner>

</Partnerek>
</DbConnectorResponse>

...

Partnerek 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.

Panel

bgColor	AliceBlue
titleBGColor	LightSteelBlue
title	GET

...

http://server/dbconnector/api/torzs/partner?changed=2021-01-12

...

http://server/dbconnector/api/torzs/partner?new=2021-01-1

Paraméter:

...

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

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

...

bashHívás

Kódblokk

language

title
java

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

Kódblokk

language	xml
title	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

PTDEFAULT_1.

1">

    <Partner>

        <PartnerKod>MAG002</PartnerKod>

        <PartnerRovnev>Magyar Posta Zrt.</PartnerRovnev>

<PartnerNev>Magyar Posta Zrt.</PartnerNev>
        <Adoalany>DOMESTIC</Adoalany> 
        <Adoszam/>

<CimIrsz>1063</CimIrsz>

<cimVaros>Budapest</cimVaros>

<CimVaros>Budapest</CimVaros>

<CimUtca>Virág

<cimUtca>Virág

u. 10.</

cimUtca>

CimUtca>

    </Partner>

    <Partner>

        <PartnerKod>TEL001</PartnerKod>

        <PartnerRovnev>Telenor</PartnerRovnev>

        <PartnerNev>Telenor Magyarország Zrt.</PartnerNev>
        <Adoalany>DOMESTIC</Adoalany>
        <Adoszam/>

<CimIrsz>2040</CimIrsz>

<cimVaros>Budaörs</cimVaros>

<CimVaros>Budaörs</CimVaros>
        <CimUtca>Baross

<cimUtca>Baross

u. 165</

cimUtca>

CimUtca>

      </Partner>

  </Partnerek>
</DbConnectorResponse>

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

Content

Munkatér eszközei

Összehasonlított verziók

Régi verzió 2

Új verzió Aktuális

Kulcs

Partner kódok listája

Partner kódok listája

Egy partner részletes adatai

Partnerek részletes adatai tömbként

Partnerek részletes adatai tömbként

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

Partnerek keresése adótörzsszám szerint

Partnerek keresése megnevezés szerint

Partnerek keresése e-mail cím szerint

Partnerek keresése bankszámlaszám szerint

Partnerek keresése partnercsoport szerint

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