API

https://most.programtech.hu/docs/?id=217 Nyomtatás

Az API (Application Programming Interface) olyan programozói kapcsolódási felület, amely lehetővé teszi, hogy más szoftverek emberi beavatkozás nélkül adatokat kérdezzenek le és meghatározott műveleteket hajtsanak végre a MOST ügyviteli rendszerben.

Tartalomjegyzék:

Bevezető
Végpontok
Tesztelés

Bevezető

Az API felület működéséhez elengedhetetlen, hogy a MOST ügyviteli szoftver adatbázisa a felhőben, azaz az Adatbázis Tárhely Szolgáltatás keretében a szerverünkön fusson. Az elérés biztonsági okokból nincs engedélyezve automatikusan, ezzel kapcsolatban kérjük, vegye fel a kapcsolatot ügyfélszolgálatunkkal.

Az API minden végpontja HTTPS kapcsolaton keresztül, header alapú hitelesítéssel érhető el. Az azonosításhoz szükséges:

X-FELHOKOD – 8 számjegyű felhőkód
X-API-JELSZO – API jelszó

Végpontok

A végpontok alkalmasak a szolgáltatások igénybevételére. Az időszaki lekérdezések jellemzően egy hónapos intervallumra vannak korlátozva. A dátum formátuma: YYYY-MM-DD.

SetDocumentFulfillableStatus

Ez a végpont beállítja a megadott bizonylat „Teljesíthető” státuszát. A bizonylat azonosítása a bizonylattípus megnevezése és a „Bizonylat sorszám” alapján történik.

type – bizonylattípus megnevezése (pl. SZÁMLA)
number – Bizonylat sorszám
status – true vagy false


GET /SetDocumentFulfillableStatus?type=SZÁMLA&number=P/HUF/000001&status=true

SetInvoicePaidStatus

Ez a végpont számla típusú bizonylatok kifizetett / nem kifizetett státuszát kezeli. A művelet a kapcsolódó pénzügyi adatok módosításával történik.

number – Számla bizonylat sorszám
status – true (kifizetett) vagy false (kifizetetlen)


GET /SetInvoicePaidStatus?number=P/HUF/000001&status=true

GetStockMovements

Ez a végpont a raktári mozgás tételeket adja vissza időszakra. A szűrés a „Kelt” mező alapján történik.

from – kezdő dátum (YYYY-MM-DD)
to – záró dátum (YYYY-MM-DD)


GET /GetStockMovements?from=2025-01-01&to=2025-01-31

GetDocuments

Ez a végpont bizonylat- és tételadatokat szolgáltat időszakra. A szűrés a „Kelt” mező alapján történik, valamint megadható a bizonylattípus.

type – bizonylattípus megnevezése (pl. SZÁMLA)
from – kezdő dátum (YYYY-MM-DD)
to – záró dátum (YYYY-MM-DD)


GET /GetDocuments?type=SZÁMLA&from=2025-01-01&to=2025-01-31

GetStockByItemId

Ez a végpont egy adott „Tétel ID” alapján adja vissza a készletinformációkat.

itemId – Tétel azonosító


GET /GetStockByItemId?itemId=12345

GetDocumentsPackagingStatus

Ez a végpont időszakra listázza a bizonylatokat és jelzi, hogy az adott bizonylat csomagolva lett-e.

from – kezdő dátum (YYYY-MM-DD)
to – záró dátum (YYYY-MM-DD)


GET /GetDocumentsPackagingStatus?from=2025-01-01&to=2025-01-31

Tesztelés

Az API végpontok tesztelhetők parancssorból a curl segédprogrammal. A hitelesítéshez szükséges headereket minden hívásnál meg kell adni.


curl -i -H "X-FELHOKOD: FELHOKOD_HELYE" -H "X-API-JELSZO: API_JELSZO_HELYE" "https://felho.programtech.hu/most/api/v1/GetDocuments?type=SZÁMLA&from=2025-01-01&to=2025-01-31"

Távsegítség

Bemutató kérése

Elérhetőség

API