A kiválasztott változat és az aktuális verzió közötti különbségek a következők.
Előző változat mindkét oldalonElőző változatKövetkező változat | Előző változatUtolsó változatKövetkező változat mindkét oldalon | ||
spec:thorr_api_felulet [2020/06/19 22:32] – ↷ Links adapted because of a move operation 66.249.76.61 | spec:thorr_api_felulet [2021/11/16 16:44] – [Összekészített rendelés visszaigazolás] csetom | ||
---|---|---|---|
Sor 1: | Sor 1: | ||
====== THORR Kommunikációs API ====== | ====== THORR Kommunikációs API ====== | ||
- | r17114 | ||
- | ===== Paraméterek | + | ===== Paraméterek ===== |
- | ==== idő ==== | + | ^ Paraméter ^ Leírás ^ |
+ | | ido |// | ||
+ | | b64_xml | Base64 kódolásban egy XML adatstruktúra. \\ Az XML-ben a ''< | ||
+ | | bizszam | // | ||
+ | | művelet | eVIR-ben ezeket '' | ||
+ | | token | A feéhasználó, | ||
- | idő típusú adat megadásának dátum formátuma **ISO 8601** | + | A paramétereket POST és GET metódussal is át lehet adni. Egyszerűbb esetekben célszerű lehet magában sz URL-ben megadni, pl: < |
- | '' | + | ===== Implementált funkciók ===== |
- | Egyelőre az ilyen tipusú adat az ''' | + | ==== Változott cikkek ==== |
+ | * **dok:** thorr_api_get_material | ||
+ | * **Paraméter: | ||
+ | * **Leírás: | ||
+ | * **Thorr dokumentum: | ||
+ | * **Adatok: | ||
+ | < | ||
+ | MATERIAL_CODE => Cikkszám, | ||
+ | MATERIAL_NAME => Cikk megnevezése, | ||
+ | MATERIAL_TYPE => 'T', | ||
+ | M_ACTIVE => Termék aktív-e, | ||
+ | </ | ||
- | ==== művelet (dok) ==== | + | ---- |
+ | ==== Új cikkek | ||
+ | * **dok:** thorr_api_get_material_new | ||
+ | * **paraméter: | ||
+ | * **Leírás: | ||
+ | * **Thorr dokumentum: | ||
+ | * **Adatok:** | ||
+ | < | ||
+ | ld: ' | ||
+ | </ | ||
- | minden műveletnek saját '' | + | ---- |
+ | ==== Változott partnerek ==== | ||
+ | * **dok:** thorr_api_get_shipto | ||
+ | * **Paraméter: | ||
+ | * **Leírás: | ||
+ | * **Thorr dokumentum: | ||
+ | * **Adatok:** | ||
+ | < | ||
- | ==== token ==== | + | SHIPTO_CODE |
+ | SHIPTO_NAME | ||
+ | |||
+ | Partner cím: | ||
- | A token létrehozásával és használatával kapcsolatban lásd [[evir:api: | + | SHIPTO_COUNTRY => Országkód, |
+ | SHIPTO_CITY => Város, | ||
+ | SHIPTO_STREET => Közterület, | ||
+ | SHIPTO_POST_CODE => Irányítószám, | ||
+ | |||
+ | Jelenleg a CUST adatok megegyeznek a SHIPTO adatokkal: | ||
- | ===== paraméterek használata ===== | + | |
+ | | ||
+ | |||
+ | Partner cím: | ||
- | A paramétereket meg lehet adni egyszerűen az URL-ben. | + | |
+ | | ||
+ | | ||
+ | | ||
+ | |||
+ | </ | ||
- | pl: | + | ---- |
+ | ==== Új partnerek ==== | ||
+ | * **dok:** thorr_api_get_shipto_new | ||
+ | * **Paraméter: | ||
+ | * **Leírás: | ||
+ | * **Thorr dokumentum: | ||
+ | * **Adatok:** < | ||
- | '' | + | ---- |
+ | ==== Szállítói megrendelések ==== | ||
+ | * **dok:** thorr_api_get_inbound | ||
+ | * **Paraméter: | ||
+ | * **Leírás: | ||
+ | * **Thorr dokumentum: | ||
+ | * **Adatok:** | ||
+ | < | ||
+ | PO_HEAD | ||
+ | PO_NUMBER | ||
+ | SUPPLIER_CODE | ||
+ | PO_ITEM => | ||
+ | MATERIAL_CODE => Cikkszám, | ||
+ | EXPECTED_QUANTITY => Mennyiség, | ||
+ | PO_ITEM_ID => Tétel id: eviren belüli unique azonosító a berendelés tételéhez, | ||
+ | </ | ||
- | ===== Implementált funkciók ===== | + | ---- |
+ | ==== Betárolás szállítói megrendelés alapján | ||
+ | * **dok:** thorr_api_po_itemupdate | ||
+ | * **Paraméter: | ||
+ | * **Leírás: | ||
+ | * **Thorr dokumentum: | ||
+ | * **Adatok:** < | ||
- | ^ 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 | + | ==== Betárolás szállítói rendelés |
+ | * **dok:** thorr_api_inbound_itemupdate | ||
+ | * **Paraméter: | ||
+ | * **Leírás: | ||
+ | * **Thorr dokumentum: | ||
+ | * **Adatok:** < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
- | ===== Válaszüzenet | + | ---- |
+ | ==== Teljesíthető vevői rendelés | ||
+ | * **dok:** thorr_api_get_order | ||
+ | * **Paraméterek: | ||
+ | * **Leírás: | ||
+ | * **Thorr dokumentum: | ||
+ | * **Adatok:** | ||
+ | < | ||
+ | ORDER_HEAD=> | ||
+ | ORDER_NUMBER | ||
+ | DELIVERY_DATE => Szállítási határidő, | ||
+ | SHIPTO_CODE | ||
+ | CUST_CODE | ||
+ | CUSTOMER_PICKUP => ' | ||
+ | ORDER_NOTE => Megjegyzés, | ||
+ | |||
+ | ORDER_ITEM => | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | </ | ||
- | Sikeres lekérdezés esetén XML fájl kerül visszaadásra | + | ---- |
+ | ==== Letöltött vevői rendelések visszaigazolása ==== | ||
+ | * **dok:** thorr_api_order_confirmed | ||
+ | * **Paraméter: | ||
+ | * **Leírás: | ||
+ | * **Thorr dokumentum: | ||
+ | * **Adatok:** < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | < | ||
+ | ... | ||
+ | </ | ||
+ | </ | ||
- | 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 '' | ||
- | 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 | + | ==== Összekészített rendelés visszaigazolás ==== |
+ | * **dok:** thorr_api_order_picked | ||
+ | * **Paraméter: | ||
+ | * **Leírás: | ||
+ | * **Thorr dokumentum: | ||
+ | * **Adatok:** | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | ... | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
- | ===== Fejlesztési segédlet, jogosultság ===== | + | ---- |
- | Az API használathoz | + | ==== Kiszállított rendelés visszaigazolás ==== |
+ | * **dok:** thorr_api_order_delivered | ||
+ | * **Paraméter: | ||
+ | * **Leírás: | ||
+ | * **Thorr dokumentum: | ||
+ | * **Adatok:** < | ||
+ | |||
+ | |||
+ | ==== Aktuális készlet, leltárív ==== | ||
+ | |||
+ | * **dok:** thorr_api_actual_stock | ||
+ | * **Paraméter: | ||
+ | * **Leírás: | ||
+ | * **Thorr dokumentum: | ||
+ | * **Adatok:** | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | < | ||
+ | ... | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== Általános információk ===== | ||
+ | * Azoknál az API hívásoknál, | ||
+ | * Sikeres lekérdezés esetén XML fájl kerül visszaadásra | ||
+ | * Az XML file névében, valamint a HEADER TIMESTAMP mezőben visszaadásra kerül a lekérdezéskori eVIR oldali timestamp, ami a következő lekérdezések '' | ||
+ | * A visszaadott adatok szerkezete és tartalma a jövőben változhat az specifikáció és az üzleti igényeknek megfelelően. | ||
+ | |||
+ | ===== Limitációk, | ||
+ | * A SHIPTO és CUST adatok a partner elsődleges címadataiból jönnek, függetlenül attól, hogy esetleg van a partnernek külön szállítási, | ||
+ | |||
+ | |||
+ | ===== Fejlesztési segédlet, jogosultság ===== | ||
- | pl: **th01 th02** | + | Az API használathoz a felhasználónak a '' |
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, | 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, | ||
+ | ---- | ||
+ | A dokumentáció alapján használható eVIR verzió: 18179 | ||
+ | ---- | ||
+ | A fejlesztéshez használt Thorr specifikáció: | ||