Přehled API
Čtecí rozhraní nad projekcí. Zapisovatelem je rejstřík; jediná zapisovací cesta v API je rozhodnutí ve frontě kontroly.
Dnes existují jen /health, /version a statický web. Zbytek je navržený kontrakt, ne implementace — viz roadmapa.
Principy
- Typované a verzované. Prefix
/v1, Pydantic modely, OpenAPI schéma. - Chyby jako
application/problem+jsonse stabilnímtype. Text chyby je vždy bezpečný — nikdy nenese payload ani osobní údaj. - Každá hodnota nese provenienci. Částka v odpovědi přichází s ID dokumentu, stránkou a confidence. Odpověď bez provenience není zkratka, je to jiný produkt.
- Autentizace API klíčem, per-consumer rozsah a limity. Bajty dokumentů a jména fyzických osob vyžadují ověřeného volajícího.
Endpointy
| Metoda | Cesta | Vrací |
|---|---|---|
| GET | /health | liveness — existuje |
| GET | /version | verze buildu, prostředí, rollout stage — existuje |
| GET | /health/dependencies | databáze, Redis, zpoždění feedu, stav jističe |
| GET | /v1/proceedings | řízení podle soudu, IČO dlužníka, způsobu řešení, stavu, dat |
| GET | /v1/proceedings/{sp_zn}/claims | dílčí pohledávky v řízení |
| GET | /v1/claims/{id} | klasifikace, stav a úplná historie událostí |
| GET | /v1/creditors/{id} | identita, historie, segmenty, agregáty |
| GET | /v1/transfers | postoupení podle §18 — sekundární trh |
| GET | /v1/review | fronta lidské kontroly |
| POST | /v1/review/{id}/decision | rozhodnutí analytika — jediná zapisovací cesta |
| GET | /v1/exports/{dataset} | hromadný export pro navazující analytiku |
Alerting
Definované události se posílají odběratelům místo dotazování: nová přihláška sledovaného věřitele, popření sledované pohledávky, vydané rozvrhové usnesení, postoupení podle §18 a nová účetní závěrka.