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

Összehasonlított verziók

Régi verzió 8

changes.mady.by.user QSoft

Mentés ekkor:

összehasonlítva

Új verzió 9

changes.mady.by.user QSoft

Mentés ekkor:

Kulcs

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

...

Panel
bgColorAliceBlue
titleBGColorLightSteelBlue
titleGET | POST | PUT

http://server/dbconnector/api/.....

Az egyes törzsadatok elérése funkciók 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 

...

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 Egyes verb-eknél további header paraméterek átadása is szükséges lehet.

...

Panel
bgColorAliceBlue
titleBGColorLightSteelBlue
titleGET | 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ó.

Alapesetben csak az API elérhetőségét teszteljük. Ez ekvivalens a böngésző címsorból meghívott móddal.

Kódblokk
languagejava
titleHívás minta - API elérhetősége - böngészőből is meghívható
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.

Kódblokk
languagejava
titleHívás minta - Authentikációs adatok tesztelésehasználata
CURL.EXE 	^
  -X POST   ^
     http://server:8080/dbconnector/api/v1/test	^
	-H pkod:SajatSupPartnerKod	^
	-H lickod:SajatSupLicKod
Kódblokk
languagexml
titleVálasz minta
<?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)</Message>
</DbConnectorResponse>

Minden API hívás egy <DbConnectorResponse> típusú XML válasszal tér vissza

A <Success> arra vonatkozóan ad információt, hogy a hívás sikeres volt-e
A <StatusCode> megegyezik a http statuskóddal

...