Áttekintés
A Szaturnusz rendszerhez tartozó Web API-k leírását tekintheti meg.
Alap URL: https://zimbra.szatuna.hu:18821
Hitelesítés
Az API-k jelenleg nem igényelnek hitelesítést. Az összes végpont nyilvánosan elérhető.
GET Végpontok
Teljes raktárkészlet lekérdezése
GET
/stock.php
Az összes raktárban rendelkezésre álló cikkszám lekérdezése. Tartalmazza a szokványos raktárat, a fóliás raktárat és a szett cikkszámokat. Csak pozitív készletű cikkszámok kerülnek visszaadásra.
Lekérdezési paraméterek
| Paraméter | Típus | Státusz | Leírás |
|---|---|---|---|
| format | string | opcionális | Válasz formátuma: json, csv, xml. Alapértelmezett: json |
| item_id | string | opcionális | Szűrés egy konkrét cikkszámra. Pontos egyezés szükséges |
Sikeres válasz (JSON)
200 OK
[
{
"item_id": "PART001",
"total_amount": 42
},
{
"item_id": "PART002",
"total_amount": 15
},
{
"item_id": "PART003+PART004",
"total_amount": 8
}
]
Válasz formátumok
Az API-k támogatják a JSON, CSV és XML kimeneti formátumokat. Válassz a format paraméterrel.
JSON formátum (alapértelmezett)
Kérés
/stock.php?format=json
Válasz
[
{
"item_id": "PART001",
"total_amount": 42
}
]
CSV formátum
Kérés
/stock.php?format=csv
Válasz
item_id,total_amount
PART001,42
PART002,15
PART003+PART004,8
XML formátum
Kérés
/stock.php?format=xml
Válasz
<?xml version="1.0"?>
<root>
<item>
<item_id>PART001</item_id>
<total_amount>42</total_amount>
</item>
</root>
Hibák és státuszkódok
Az API-k lekérdezési hibái közvetlenül a kimenetre íródnak. Az alábbi HTTP státuszkódok lehetségesek:
200 OK
A kérés sikeres. Az eredmények JSON/CSV/XML formátumban kerülnek visszaadásra
500 Internal Server Error
Adatbázis kapcsolat vagy lekérdezési hiba. Az error üzenet az stdout-ra íródik
Paraméter validáció
Az API alapértelmezés szerint figyelmen kívül hagyja az érvénytelen paramétereket:
format– Érvénytelen érték esetén JSON alapértelmezettitem_id– Nem tárolt item_id esetén üres tömb kerül visszaadásra