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

Korábbi változatok

Összehasonlított verziók

Kulcs

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

A DbConnector alkalmazáshoz kapcsolódó REST 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ő elhívásokkal működtethető.

Részleg

Oszlop

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.

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.

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

API tesztelése

Az API elérhetőségének tesztelése a a DbConnector REST API oldalon található.
Az dokumentációban az API műveletek bemutatására a széles körben elterjedt CURL segítségével történikAz egyes verb-eknél további header paraméterek átadása is szükséges lehet.

Oszlop

width	50 %

Panel

bgColor	Beige

Tartalom

Tartalomjegyzék

maxLevel	2

Partnertörzs

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 A SUP^® rendszer partnertörzs állománya a következő verb-en érhető el.

...

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

Paraméter További header 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.

...

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

...

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

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

...

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

ParaméterResult
XML - <Partnerek> : megnev A cég rövid nevében és teljes nevében keres.

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

...

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

További header 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.

Paraméter
bankszla 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
XML - <ResultList> : A lekérdezés több rekordot is adhat eredményül.

Kódblokk

language	bash
title	Hívás minta

CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/partner?bankszla=1090009912345678   ^
  -H pkod:SajatSupPartnerKod <PartnerNev>Magyar Posta Zrt.</PartnerNev>^
  -H lickod:SajatSupLicKod     ^
  -H  <Adoszam/>
cegkod:CegKod             <cimIrsz>1063</cimIrsz>^
  -H format:default

Kódblokk

language	xml
title	Válasz minta

<?xml version="1.0"   encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
     <cimVaros>Budapest<<Success>true</cimVaros>Success>
            <cimUtca>Virág u. 10.</cimUtca><StatusCode>200</StatusCode>
        </Partner><Partnerek version="PTD_1.0">
        <Partner>
            <PartnerKod>TEL001<<PartnerKod>TET001</PartnerKod>
            <PartnerRovnev>Tételes <PartnerRovnev>Telenor<ÁFA Kft.</PartnerRovnev>
            <PartnerNev>Telenor<PartnerNev>Tételes MagyarországÁFA ZrtKft.</PartnerNev>
            <Adoszam/>
            <cimIrsz>2040<<cimIrsz>1111</cimIrsz>
            <cimVaros>Budaörs<<cimVaros>Budapest</cimVaros>
            <cimUtca>Baross<cimUtca>Zöld u. 165<11.</cimUtca>
        </Partner>
    </Partnerek>
</DbConnectorResponse>

Partner

...

keresés partnercsoport szerint

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

GET
`http://server/dbconnector/api/torzs/partner?bankszlapcsop=10900099123456781`

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

Paraméter
pcsop 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
XML - <ResultList> : A lekérdezés több rekordot is adhat eredményül.

Kódblokk

language	bash
title	Hívás minta

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

...

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 cikk-kódok listája vesszővel elválasztva.

...

Egy cikk részletes adatai

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

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

Paraméter További header 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.

Kódblokk

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

...

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

Paraméter További header 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.

...

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

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

...

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

...

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

...

Content

Munkatér eszközei

Összehasonlított verziók

Régi verzió 2

Új verzió 3

Kulcs

API tesztelése

Partnertörzs

API tesztelése

Partnertörzs

Partnerek listája

Partnerek listája

Partner keresés bankszámlaszám szerint

Partner

keresés partnercsoport szerint

Egy cikk részletes adatai