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

Összehasonlított verziók

Kulcs

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

...

Result
   XML - <Success>    :  true | false
   XML - <StatusCode> :  A HTML státuskódhoz hasonló részletesebb informá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 az adott feladathoz igazodva

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, vagy az erre a célra fejlesztett önálló szoftverek, pl.: PostMan.

Intraneten kívüli használat

Bár az 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.

Qsboxfigyelem

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.

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.