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

Összehasonlított verziók

Régi verzió 1

changes.mady.by.user QSoft

Mentés ekkor:

összehasonlítva

Új verzió Aktuális

changes.mady.by.user QSoft

Mentés ekkor:

Kulcs

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

Az API felület a DbConnector alkalmazás Főkönyvi feladás automatizált fogadása funciót teszi elérhetővé webszolgáltatásként.
A webszolgáltatás XML alapú REST API hívásokkal működtethető.

...

width50%

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

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

Panel
bgColorAliceBlue
titleBGColorLightSteelBlue
titlePOST | GET
    

http://server/dbconnector/api/v1

A főkönyvi feladás API

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

Az API hívás  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.
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.

Oszlop
width50 %
Panel
bgColorBeige

Tartalom

Tartalomjegyzék
maxLevel1

...

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

Rögzítés
xmlFokfelad
xmlFokfelad
Főkönyvi feladás beküldése

Panel
bgColorAliceBlue
titleBGColorDarkSalmon
titlePOST

...

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

A hívás célja, hogy külső rendszer kontírozott főkönyvi feladást tudjon

...

küldeni SUP rendszer DbConnector moduljának. A beküldött

...

bash

feladásnak teljesítenie kell a Főkönyvi feladás adatállomány XML sémával leírt formátumot. Tartalmilag pedig az adott cégben tárolt törzsadatokhoz kell igazodnia. A DbConnector modul file alapú megoldással képes fogadni ugyanezt az XML-t, a Főkönyvi feladás automatizált fogadása funkcióval.

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.

Paraméter (kötelező)
   XML : Főkönyvi feladás XML

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
java
titleHí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
languagexml
titleVá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>
Qsboxmegjegyz

File-ként létrehozott XML esetén figyelni kell arra, hogy BOM nélküli XML-t kell feltölteni.

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

Panel
bgColorAliceBlue
titleBGColorLightSteelBlue
titleGET

...

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 SUP rendszerben azonosító adatot (napló |

...

bizonylatszám).

...

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

Result
   XML - <BizonylatAzon> :

...

Az elkészült

...

bizonylat azonosítója a SUP rendszerben (napló |

...

bashHívás

bizonylatszám).

Kódblokk
language
java
title
Kérés minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/v1/getstatus?token=
B03D8188
7085BEEC-
2159
93B0-
4174
4FE1-
A866
88BB-
E214988DFB2A
F531EDAC38D6
^
 ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod
 Kódblokk
languagexml
titleVá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
languagexml
titleVálasz minta #2
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
    <Success>true</Success>
    <StatusCode>200</StatusCode>
    <BizonylatAzon>501|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
SuccessSikeres feldolgozás esetén true, egyéb esetben false
StatusCodeSikertelen feldolgozás esetén további, részletesebb információkat közöl. Megegyezik a http statuskóddal, de a hívás sikerességének ellenőrzéséhez a nem ezt, hanem a http statuskódot kell használni.
MessageSikertelen feldolgozás esetén szöveges információk a problémáról, összhangban a StatusCode válasszal.
TokenKé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 
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.
...
könyvelési bizonylat.
  • 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.
...
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.
 Rögzítés
statusKodok
statusKodok
Hibakezelés - hibakódok
Az XML result-ban visszaadott státuszkódok megegyeznek a HTTP hívás státuszkódjaival. A fejlesztés során inkább a HTTP státuszkódokkal érdemes dolgozni,, mert előfordulhat olyan eset (pl.: time out), hogy a HTTP kérés válaszban nem az elvárt XML üzenet jön, hanem csak egy hibakód.
A témában további információk a DbConnector REST API általános dokumentációban.
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 szükséges azonosító kódok előzetes egyeztetés után lesznek létrehozva.
Hibakezelés
API elérhetőség hiba
Authentikációs hiba