Felhasználói eszközök

Eszközök a webhelyen


spec:thorr_api_felulet

Különbségek

A kiválasztott változat és az aktuális verzió közötti különbségek a következők.

Összehasonlító nézet linkje

spec:thorr_api_felulet [2020/03/16 22:28] (aktuális)
delfin létrehozva
Sor 1: Sor 1:
 +====== THORR Kommunikációs API ======
 +
 +r17114
 +
 +===== Paraméterek magyarázata =====
 +
 +==== idő ====
 +
 +idő típusú adat megadásának dátum formátuma **ISO 8601**
 +
 +''​YYYY-MM-DD HH:​mm:​ss.ppp''​ (Postgresql-ben használt timestamp formátum)
 +
 +Egyelőre az ilyen tipusú adat az '''​ido''​ névvel rendelkezik
 +
 +==== művelet (dok) ====
 +
 +minden műveletnek saját ''​dok''​ kulcsa van. A lentebbi táblázat szerint.
 +
 +==== token ====
 +
 +A token létrehozásával és használatával kapcsolatban lásd [[:​api_altalanos]] ​
 +
 +===== paraméterek használata =====
 +
 +A paramétereket meg lehet adni egyszerűen az URL-ben.
 +
 +pl:
 +
 +''​https://​........./​cgi-bin/​index.cgi?​token=A1B2C3D4&​dok=thorr_api_get_material_change&​ido=2020-03-01%2012:​34''​
 +
 +===== Implementált funkciók =====
 +
 +^ Művelet ^ dok ^ paraméter ^
 +| Változott cikkek | thorr_api_get_material_change | ido | Az adott idő óta változott cikkek listája (az újakkal együtt) |
 +| Új cikkek | thorr_api_get_material_new | ido | Az adott idő óta létrehozott új cikkek listája |
 +| Változott partnerek | thorr_api_get_shipto_change | ido | Az adott idő óta változott partnerek listája (az újakkal együtt) |
 +| Új partnerek | thorr_api_get_shipto_new | ido | Az adott idő óta létrejött új partnerek listája |
 +
 +Idő megadása nélkül szűrés nélküli lekérdezéssel minden lekérdezhető.
 +
 +===== Válaszüzenet =====
 +
 +Sikeres lekérdezés esetén XML fájl kerül visszaadásra
 +
 +A filenévben (illetve a HEADER TIMESTAMP mezőben) visszaadásra kerül a lekérdezéskori EVIR oldali timestamp, ​
 +így ez az időpont használható a következő lekérdezések ''​ido''​ paramétereként folytatólagos lekérdezéshez.
 +
 +A visszaadott adatok szerkezete és tartalma a jövőben változhat. Jelen verzióban (r17114)
 +fejlesztési demonak tekintendő.
 +
 +Érvényes a jelenleg hiányzó mezők bővítésére,​ illetve a partner adatoknál a __megfelelő__ címadatok visszaadására. (Jelenleg SHIPTO és CUST adatok ugyanúgy a partner elsődleges címadataiból dolgozik)
 +
 +===== Fejlesztési segédlet, jogosultság =====
 +
 +Az API használathoz a usernek a ''​Rendszer/​API/​Thorr/​API Form''​ menüponthoz kell jogosultságot adni
 +
 +pl: **th01 th02**
 +
 +Fejlesztési segédletként ezen a menüponton elérhető egy form, ahol megadható az idő és a megfelelő gomb megnyomásával lekérdezhetők az adatok. Ez a használat a fejlesztést segítendően létezik. A paraméterezése kicsit eltér az itt dokumentálttól,​ de a visszaadott eredmény megegyezik.
 +
 +
  
spec/thorr_api_felulet.txt · Utolsó módosítás: 2020/03/16 22:28 szerkesztette: delfin