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ó API felület az alkalmazás néhány funkcióját delegálja intranetes webszolgáltatásként.
A webszolgáltatás XML alapú REST API kezelési móddal érhető el.

Részleg

Oszlop

width	50%

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

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

A számlázási API aszinkron működésű. A beküldött kérések várólistába kerülnek. A feldolgozottsági állapot lekérdezésére külön API hívás van. A válaszok XML-ben érkeznek.

Oszlop

width	50 %

Panel

bgColor	Beige

Tartalom

Tartalomjegyzék

maxLevel	1

A várólistát egy időzítetten futó feldolgozó üríti ki. A feldolgozás közben várólistába kerülő új elemek a következő feldolgozási periódusba kerülnek.

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

Rögzítés
teszt
teszt
API tesztelése

GET | POST
http://server/dbconnector/api/v1/test

A hívás célja az API elérhetőségének tesztelése. Az elérhetőség egyszerű tesztelésére bármely böngésző alkalmas. A komplex teszteléséhez pl.: a széles körben elterjedt CURL használható.

Body paraméter (opcionális raw data)
dummy

Result
XML - <Success> : true | false
XML - <StatusCode> : A HTML státuskódhoz hasonló részletesebb információ.

Alapesetben csak az API létezését teszteljük. Ez közel ekvivalens a böngésző címsorból meghívott móddal.

Kódblokk

language	bash
title	Hívás minta - API elérhetősége

CURL.EXE    ^
  -X GET    ^
     http://server/dbconnector/api/v1/test

A teljes teszthez meg kell adni a hitelesítő adatokat is. Siker esetén egy verziószám a válasz.

Kódblokk

language	bash
title	Hívás minta - Authentikációs adatok tesztelése

CURL.EXE 	^
  -X POST   ^
     http://server:8080/dbconnector/api/v1/test	^
	-H pkod:SajatSupPartnerKod	^
	-H lickod:SajatSupLicKod

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>API build: 1.0.6536M (2018.08.09. 16:07:30) DbConnector DLL: 15.1 (2018.08.01. 8:16:32)</Message>
</DbConnectorResponse>

Rögzítés
xmlSzamla
xmlSzamla
Számla beküldése

POST
http://server/dbconnector/api/v1/postxml

A hívás célja, hogy a Kimenő számla importálás XML sémával leírt, külső rendszerben előállított számlázási utasítás alapján a SUP rendszer DbConnector modulja a Kimenő számlák automatizált készítése funkciója webes felületen keresztül is elérhető legyen.

Qsboxmegjegyz
A beküldés egy aszinkron feldolgozás, a beküldött XML-ek várólistába kerülnek, a feldolgozottsági állapotot a későbbiekben le kell kérdezni. Megfelelő szerver oldali beállítások esetén a sikeres feldolgozottsági státussal együtt a számla PDF képe is visszaadásra kerül a hivóhoz.

Paraméter (kötelező)
XML : A számázási utasítás XML (az esetleges számla csatolmányokat előzetesen kell feltölteni)

Result
XML - <Token> : Sikeres beküldés esetén a kapott adatot meg kell őrizni. A feldolgozás eredménye ezzel az azonosítóval kérhető le.

Kódblokk

language	bash
title	Hívás minta

CURL.EXE    ^
  -X POST   ^
     http://server:8080/dbconnector/api/v1/postxml ^
  -H pkod:SajatSupPartnerKod  ^
  -H lickod:SajatSupLicKod    ^
  -H "Content-Type: text/html; charset=UTF-8" ^
  --data-ascii @testUpload.xml

Kódblokk

language	xml
title	Válasz minta

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
    <Success>true</Success>
    <StatusCode>200</StatusCode>
    <Token>7085BEEC-93B0-4FE1-88BB-F531EDAC38D6</Token>
</DbConnectorResponse>

Rögzítés
upload
upload
Számla csatolmány feltöltése

POST
http://server/dbconnector/api/v1/upload

A számlához opcionálisan csatolmányként tárolt melléklet tölthető fel. Feltölthető file formátum: JPG, PDF. Amennyiben az elkészült számla is PDF formátumú, a mellékletek beágyazódnak a számla PDF-be.

A csatolmányokat a számlázási XML-t beküldést megelőzően kell feltölteni a szerverre. A válaszként kapott azonosítókat (tokenek) egy vesszővel felsorolt listában el kell helyezni az <Elojegyzett_Szamlak><Szamlak><Szamla><Csatolmanyok> adattagban.

Kódblokk

language	bash
title	Hívás minta

CURL.EXE    ^
  -X POST   ^
     http://server:8080/dbconnector/api/v1/upload ^
  -H pkod:SajatSupPartnerKod  ^
  -H lickod:SajatSupLicKod    ^
  -F file=@testupload.jpg

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>File feltöltés sikeres</Message>
    <Token>74cc7200-b9fc-4fd8-a1cf-8942c09afc35</Token>
</DbConnectorResponse>

Rögzítés
getStatus
getStatus
Feldolgozottsági állapot lekérdezése

GET
http://server/dbconnector/api/v1/getstatus

A hívás célja a korábban a feldolgozási várólistába beküldött XML dokumentum feldolgozottsági státusának lekérdezése. A kérés azonosításához az XML beküldéskor válaszként kapott tokent kell használni.

Sikeres feldolgozás esetén válaszként visszaadja a számát a SUP rendszerben azonosító adatot (napló | számlaszám), valamint a számla PDF képet - base64 enkódolt formában.

Paraméter (kötelező)
token : Az XML beküldéskor kapott token.

Result
XML - <BizonylatAzon> : Az elkészült számla azonosítója a SUP rendszerben (napló | számla sorszám).
XML - <PdfDocument> : Az elkészült számla PDF számlaképe (megfelelő SUP beállítás esetén).

Kódblokk

language	bash
title	Hívás minta

CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/v1/getstatus?token=B03D8188-2159-4174-A866-E214988DFB2A  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod

Kódblokk

language	xml
title	Válasz minta #1

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
    <Success>false</Success>
    <StatusCode>290</StatusCode>
    <Message>A tetel feldolgozasra var</Message>
</DbConnectorResponse>

Kódblokk

language	xml
title	Válasz minta #2

 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
    <Success>true</Success>
    <StatusCode>200</StatusCode>
    <BizonylatAzon>499|DBC0001/18</BizonylatAzon>
</DbConnectorResponse>

Válasz XML

Az API hívásra adott válasz XML egy <DbConnectorResponse> séma alapján jön létre.
Adattagok

Success Sikeres feldolgozás esetén true, egyéb esetben false

StatusCode Sikertelen feldolgozás esetén további, részletesebb információkat közöl

Message Sikertelen feldolgozás esetén szöveges információk a problémáról, összhangban a StatusCode válasszal

Token Kérés beküldés esetén a várólistából ezzel az azonosítóval lehet majd a status információkat lekérni

BizonylatAzon

Számlázási utasítás beküldés és sikeres feldolgozás esetén, a SUP rendszerben a megadott azonosítón található meg a számla.

Qsboxmegjegyz
A feldolgozás során a `BizonylatAzon` információ akkor is visszajön, ha a teljes folyamat nem volt sikeres (pl. nem sikerült hitelesíteni az e-számlát), de a számla bizonylat létrehozása sikeres volt.

PdfDocument Számlázási utasítás beküldés és sikeres feldolgozás esetén, az elkészült számla PDF képe base64 enkódolt formában. A számla PDF kép visszaadáshoz a szerver oldalon további beállítások szükségesek. Ha ez nincs, akkor csak a BizonylatAzon információ jön vissza

Rögzítés
statusKodok
statusKodok
Hibakódok

200 OK
290 Not yet processed
401 Unauthorized
404 Not Found
490 Auth param missing
491 Body or param missing
492 XML ERROR
493 Already exist
494 Too long time not processed
495 Error on processing
499 Other error
590 INI error
591 Database connect error
592 Other Exception

Kliens implementáció

A kliens implementáció első lépése az API működésének tesztelése. A tesztelés két üzemmódban lehetséges.

API url elérhetőségének ellenőrzése
API teljeskörű tesztelése

A működés teszteléséhez a a széles körben elterjedt CURL használható. Szintén használhatók a különböző böngészőkhöz készített bővítmények.

Intraneten kívüli használat

Bár az API alapvetően intranetes felhasználásra készült, nincs akadály annak, hogy megfelelő biztonsági feltételek megteremtésével az internet irányából is használható legyen.

A QSoft Kft. az API kipróbálásához webes teszt-felületet hozott létre, mely elérhető: http://dbconnector-apitest.sup.hu helyen.
A teszt API szintén elérhető az internetről is: http://dbconnector-apitest.sup.hu/api címen.
A használathoz, teszteléshez szűkséges azonosító kódok előzetes egyeztetés után lesznek létrehozva.

Content

Munkatér eszközei

Összehasonlított verziók

Régi verzió 5

Új verzió 6

Kulcs

Rögzítés
teszt
teszt
API tesztelése

Rögzítés
xmlSzamla
xmlSzamla
Számla beküldése

Rögzítés
upload
upload
Számla csatolmány feltöltése

Rögzítés
getStatus
getStatus
Feldolgozottsági állapot lekérdezése

Válasz XML

Rögzítés
statusKodok
statusKodok
Hibakódok

Kliens implementáció

Intraneten kívüli használat

Hibakezelés

API elérhetőség hiba

Authentikációs hiba

Content

Munkatér eszközei

Korábbi változatok

Összehasonlított verziók

Régi verzió 5

Új verzió 6

Kulcs

RögzítésteszttesztAPI tesztelése

RögzítésxmlSzamlaxmlSzamlaSzámla beküldése

RögzítésuploaduploadSzámla csatolmány feltöltése

RögzítésgetStatusgetStatusFeldolgozottsági állapot lekérdezése

Válasz XML

RögzítésstatusKodokstatusKodokHibakódok

Kliens implementáció

Intraneten kívüli használat

Hibakezelés

API elérhetőség hiba

Authentikációs hiba

Rögzítés
teszt
teszt
API tesztelése

Rögzítés
xmlSzamla
xmlSzamla
Számla beküldése

Rögzítés
upload
upload
Számla csatolmány feltöltése

Rögzítés
getStatus
getStatus
Feldolgozottsági állapot lekérdezése

Rögzítés
statusKodok
statusKodok
Hibakódok