Přeskočit na obsah

Dokumentace

Vše potřebné pro integraci s Progresus OSINT — od prvního API volání po formát vygenerované zprávy. Autoritativní referencí API je OpenAPI specifikace ve Swagger UI; tato stránka je rozcestník a rychlý start.

Rychlý start: první šetření

  1. Získejte API klíč. Klíč vytvoří správce instance přes POST /v1/admin/api-keys; plná hodnota klíče se vrací pouze jednou, při vytvoření. V aplikaci klíč vložíte jednorázově do pole API klíče.

  2. Projděte katalog zdrojů. GET /v1/sources vrací dostupné zdroje dat včetně kategorie a právního základu — z nich vyberete rozsah šetření.

  3. Založte šetření. POST /v1/investigations se subjektem (např. firma podle IČO) a volitelným výběrem zdrojů; běh proběhne asynchronně.

  4. Vyzvedněte výsledky. Po dokončení stáhněte zjištění a důkazy, případně vygenerujte zprávu s hashovým manifestem přes POST /v1/reports.

# 1) katalog zdrojů
curl -H "Authorization: Bearer $KEY" \
  https://<instance>/v1/sources

# 2) založení šetření
curl -X POST -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "6f1c9c0e-…",
    "subject": {"kind": "company",
                "identifiers": {"ico": "04543645"}},
    "idempotency_key": "quickstart-001"
  }' \
  https://<instance>/v1/investigations

# 3) stav + zjištění
curl -H "Authorization: Bearer $KEY" \
  https://<instance>/v1/investigations/{id}
curl -H "Authorization: Bearer $KEY" \
  https://<instance>/v1/investigations/{id}/findings

Chcete jít krok za krokem?

Bootcamp je sedm modulů s reálnými curl voláními, které vás provedou od API klíče přes šetření, graf a vyhledávání až po export auditovatelné zprávy — celé jedním sezením.

Spustit bootcamp

Časté prvotní potíže

Čtyři nejčastější důvody, proč první šetření nejde podle plánu.

Šetření zůstává ve stavu queued
Sběr provádí samostatný ARQ worker (just worker), ne API proces. Bez běžícího workeru se šetření nikdy nepohne dál.
401 na každém volání
Hlavička musí být Authorization: Bearer <klíč> s plnou hodnotou vrácenou při vytvoření klíče — ta se znovu nezobrazí, klíč je nutné vytvořit znovu.
403 na jinak platném volání
API klíč nese konkrétní scopes (např. investigations:write, reports:read) přidělené při vytvoření — chybějící scope, ne chyba v datech, je nejčastější příčina.
Opakované založení šetření nic nevrátí navíc
To je záměr, ne chyba: stejný idempotency_key vrátí totéž šetření místo nového běhu. Pro nové šetření použijte nový klíč.

Témata

Bootcamp

Sedm modulů s reálnými API voláními — od API klíče po export auditovatelné zprávy, krok za krokem.

Případy užití

Onboarding dodavatelů, screening sankcí, detekce skutečných majitelů a průběžný monitoring — na reálných compliance scénářích.

API reference

Kompletní interaktivní OpenAPI reference — všechny endpointy, schémata požadavků a odpovědí, možnost vyzkoušet volání přímo proti běžící instanci.

Koncepty API

Autentizace API klíči, verzování, idempotence, chybová obálka problem+json a přehled všech zdrojů API s příklady.

Architektura

Komponenty, hranice a datové toky: FastAPI hranice, asynchronní worker, poskytovatelé, PostgreSQL jako zdroj pravdy a odvozené projekce.

Funkce a zdroje dat

Podrobný popis schopností včetně katalogu dvanácti integrovaných zdrojů (osm českých registrů, VIES, GLEIF, sankční seznamy EU a USA) a kontroly integrity důkazů.

Roadmapa

Co je implementované, co se připravuje a co je záměrně mimo rozsah — bez marketingového zamlžování.

Právní rámec a soukromí

Právní základ práce s veřejnými registry, GDPR zásady a etické hranice sběru dat.

Technická dokumentace (formát zprávy, katalog poskytovatelů s právním základem, architektura, průvodce nasazením) existuje v repozitáři projektu; zákaznický psaný portál nad rámec tohoto rozcestníku je Plánováno — viz roadmapa.

Chcete rovnou začít vyvíjet?

Otevřete aplikaci, vložte API klíč a spusťte své první šetření.

Otevřít aplikaci Procházet API referenci