A DbConnector alkalmazáshoz kapcsolódó API felület egy korszerűbb interface technika a hagyományos file alapú megoldásokhoz képest. Az API felület egyes funkciói a  DbConnector alkalmazás néhány funkcióját nyújtják azonban vannak olyan lehetőségek is, amik csak ezzel a technikával érhetők el.
A DbConnector API egy intranetes webszolgáltatás, mely XML alapú REST API hívásokkal működtethető.

Az REST API felületen keresztül elérhető lehetőségek

Az API elérhetősége

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

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

Egyes hívásokhoz további header paraméter szükséges

   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.

Az egyes verb-eknél további header paraméterek átadása is szükséges lehet.

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.

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.

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

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

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 tesztelése az adott feladathoz igazodva

A működés teszteléséhez 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, vagy az erre a célra fejlesztett önálló szoftverek, pl.: PostMan.

Intraneten kívüli használat

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.

 Figyelem

Az internetre delegált API esetén a dokumentációban leírt <DbConnectorResponse> típusú válaszok mellett más (HTML, JSON) válaszok is előfordulhatnak, attól függően, hogy az API milyen eszközzel lett kiadva az internet felé. Tehát a válaszok kezelésénél a http status kódot célszerű először vizsgálni.