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

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

Főkönyvi feladás beküldése

POST
     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 feladásna 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.

 Megjegyzés

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.

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

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

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 SUP rendszerben azonosító adatot (napló | számlaszám).

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

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

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

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

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.  Megjegyzés 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.

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.

Hibakezelés

API elérhetőség hiba

Authentikációs hiba