Kapcsolódó információk:
› Paraméterezési útmutatók
Korábbi változatok
A DbConnector alkalmazáshoz kapcsolódó API felület az alkalmazás néhány funkcióját delegálja intranetes Az API felület a DbConnector alkalmazás Kimenő számlák automatizált készítése funciót teszi elérhetővé webszolgáltatásként.
A webszolgáltatás XML webszolgáltatás XML alapú REST API kezelési móddal érhető elhívásokkal működtethető.
| Részleg | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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
...
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 | ||||
|---|---|---|---|---|
| ||||
CURL.EXE ^
-X GET ^
http://server/dbconnector/api/v1/test |
...
|
A REST API hívások általános használata a DbConnector REST API oldalon található.
| Kódblokk | ||||
|---|---|---|---|---|
| ||||
CURL.EXE ^
-X POST ^
http://server:8080/dbconnector/api/v1/test ^
-H pkod:SajatSupPartnerKod ^
-H lickod:SajatSupLicKod |
| Kódblokk | ||||
|---|---|---|---|---|
| ||||
<?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 | ||||
|---|---|---|---|---|
|
...
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 a számlázási XML-ben, a <Elojegyzett_Szamlak><Szamlak><Szamla><Csatolmanyok> adattagban.
...
Result XML - <BizonylatAzon> : Az elkészült számla azonosítója a SUP rendszerben (napló | számla sorszám). XML - <PdfDocument> <DocumentType>, <DocumentData> : Az elkészült számla PDF számlaképe (megfelelő SUP beállítás esetén).
...
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.
| ||
PdfDocumentDocumentType | 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 |
...
- 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.
...
Hibakezelés
API elérhetőség hiba
...