Přeskočit na obsah

Přehled API

Čtecí rozhraní nad projekcí. Zapisovatelem je rejstřík; jediná zapisovací cesta do dat o pohledávkách je rozhodnutí ve frontě kontroly.

Dnes existují jen endpointy označené „existuje“ — /health, /health/ready, /health/dependencies, /version, čtecí endpointy pod /api/explore, fronta kontroly pod /api/review, /api/news a komentáře pod /api/feedback — a k nim statický web a stránky aplikace pod /app (jen pro přihlášené). Zbytek, včetně všeho pod /v1, je navržený kontrakt, ne implementace — viz roadmapa.

Principy

  • Typované a verzované. Prefix /v1, Pydantic modely, OpenAPI schéma.
  • Chyby jako application/problem+json se stabilním type. 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.
# Jak API čte a kudy se zapisuje. Dnešní cesty pod /api, jen pro přihlášené. Čtení jde přes /api/explore z indexu pohledávek, který se staví z projekce, a každá pohledávka v odpovědi nese dokument, stránku a confidence. Do dat o pohledávkách se zapisuje jen rozhodnutí kontrolora přes /api/review: uloží se do append-only logu rozhodnutí a projekce ho přehraje při další přestavbě. Verzované endpointy /v1 zatím neexistují.
# Datový model kolem dílčí pohledávky. Přihláška je kontejner, jednotkou je dílčí pohledávka. Její stav je odvozený z uspořádaného seznamu událostí a každá událost odkazuje na dokument a stránku.

Endpointy

MetodaCestaVrací
GET/healthliveness — existuje
GET/versionverze buildu a prostředí — existuje
GET/health/readyreadiness — aplikace nastartovala a může přijímat provoz; oddělené od liveness — existuje
GET/health/dependenciesdatabáze, Redis, zpoždění feedu, stav jističe; diagnostika, ne sonda — existuje
GET/api/explore/searchvyhledávání, fasety a součty výběru pohledávek pro průzkum — existuje, jen pro přihlášené (role reader)
GET/api/explore/export.csvaktuální výběr jako CSV pro Excel — existuje, jen pro přihlášené
GET/api/explore/dashboardagregace výběru pro přehled — existuje, jen pro přihlášené
GET/api/explore/pivotkontingenční tabulka výběru přes dvě dimenze pro teplotní mapu a tok na přehledu — existuje, jen pro přihlášené
GET/api/explore/claim/{id}detail jedné pohledávky z indexu s citací a stránkou — existuje, jen pro přihlášené
GET/api/review/queuefronta kontroly: pohledávky a jejich tvrzení čekající na kontrolu — existuje, jen pro kontrolory
POST/api/review/claims/{…}/assertions/{key}/reviewrozhodnutí kontrolora k jednomu tvrzení (potvrdit, opravit, nedostatek podkladů, nejednoznačné, nečitelné, zamítnout) — existuje, jediná zapisovací cesta do dat o pohledávkách
POST/api/review/claims/{…}/approve, …/returnschválení druhou osobou, nebo vrácení ke kontrole s důvodem — existuje, jen pro schvalovatele (vrácení vlastního rozhodnutí i pro kontrolora)
GET/api/newsnová řízení a pohledávky v období pro aktuality — existuje, jen pro přihlášené
GET, POST/api/feedback/commentskomentáře k aplikaci; dat o pohledávkách se nedotknou — existuje, jen pro přihlášené
GET/v1/proceedingsřízení podle soudu, IČO dlužníka, způsobu řešení, stavu, dat
GET/v1/proceedings/{sp_zn}/claimsdí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/transferspostoupení podle §18 — sekundární trh
GET/v1/reviewfronta lidské kontroly
POST/v1/review/{id}/decisionrozhodnutí 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.