Kapcsolódó információk:
› Paraméterezési útmutatók
Korábbi változatok
...
Az API a következő belépési ponton érhető el. A szerver név a helyi intranetet környezettől függ.
| Panel | ||||||
|---|---|---|---|---|---|---|
|
...
|
...
|
...
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 |
Az adatok a SUP rendszert felhasználó cég számára átadott licence adatlapon találhatók.
...
Az egyes verb-eknél további header paraméterek átadása is szükséges lehet.
| Qsboxfigyelem |
|---|
Az API korlátozza a másodpercenkénti hívások számát, mivel a terhelhetőség erősen függ a működési környezettől. Az API-t használó programnak figyelnie kell rá, hogy a 2 hívás/másodperc értéket ne lépje túl. |
API tesztelése
| Panel | ||||||
|---|---|---|---|---|---|---|
|
...
|
...
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
...
. Alapesetben csak az API |
...
elérhetőségét teszteljük. Ez |
...
ekvivalens a böngésző címsorból meghívott móddal.
| bash
| bash
Minden API hívás egy A |
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 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.
| Qsboxfigyelem |
|---|
Az API hívás sikerességét alapvetően a http statuskóddal kell ellenőrizni A válasz XML-ben levő |
Intraneten kívüli használat
Az API alapvetően intranetes felhasználásra készült, nincs . Nincs akadály annak, hogy megfelelő biztonsági feltételek megteremtésével az internet irányából is használható legyen.
...