Přeskočit obsah

REST API — Přehled

Eva.Mobile.WebApi je ASP.NET Core 9 REST API backend. Poskytuje veškerou business logiku pro mobilní aplikaci, webového správce i externí konzumenty.

Base URL

Prostředí URL
Lokální vývoj http://localhost:5000
Docker (interní) http://api:8080
Produkce dle nasazení (HTTPS)

Swagger UI (jen Development): /swagger

Autentizace

API používá JWT Bearer tokeny. Většina endpointů vyžaduje platný token v hlavičce:

Authorization: Bearer <access_token>

Viz Autentizace pro detail přihlášení a správy tokenů.

Zpětná kompatibilita

Původní controllery (před zavedením JWT) jsou stále veřejné bez autentizace — zpětná kompatibilita s mobilní aplikací. Nové controllery dědí z BaseApiController a vyžadují [Authorize].

Přehled controllerů

Controller Prefix Popis
AuthController /api/auth JWT přihlášení a tokeny
LoginController /api/login ⚠️ OBSOLETE — starý login bez JWT
ArticlesController /api/articles Správa majetku
InventoriesController /api/inventories Inventury a jejich položky
InventoryItemsController /api/inventoryitems Vložení položek inventury
LocationsController /api/locations Hierarchie lokací
ArticleCategoriesController /api/articlecategories Číselník kategorií
ArticleTypesController /api/articletypes Číselník typů
ArticleStatesController /api/articlestates Číselník stavů
ArticleDisposalMethodsController /api/articledisposalmethods Způsoby vyřazení
ArticleDisposalReasonsController /api/articledisposalreasons Důvody vyřazení
InventoryStatesController /api/inventorystates Stavy inventury
UsersController /api/users Seznam uživatelů
PhotoArticleInventoryController /api/photoarticleinventory Fotografie k inventuře
PrintingPrintersController /api/printingprinters Tiskárny
PrintingFormatsController /api/printingformats Formáty tisku
PDAPrintingController /api/pda/printing PDA — tisk
PDAUsersController /api/pda/users PDA — uživatelé

Filtrační operátory

Endpointy s parametrem filterOp (nebo filterOperator) podporují tyto hodnoty:

Hodnota Popis
Equals Přesná shoda
Contains Obsahuje podřetězec
StartsWith Začíná na
EndsWith Končí na

Příklad: 

GET /api/articles/findByName?name=notebook&filterOp=Contains

Odpovědi a chybové kódy

API vrací standardní HTTP stavové kódy:

Kód Význam
200 OK Úspěch (GET, PUT)
201 Created Záznam vytvořen (POST)
400 Bad Request Neplatný vstup (např. neshodná ID)
401 Unauthorized Chybí nebo neplatný JWT token
404 Not Found Záznam nenalezen
500 Internal Server Error Chyba serveru (tělo obsahuje zprávu)

Chybová odpověď: 

"Article with id 42 not found"

Sekce dokumentace