digna REST API 2026.11¶

REST API digna umožňuje vašim vlastním nástrojům a pipelinám pracovat s digna přes HTTP a JSON: číst projekty a výsledky inspekcí, spravovat datové zdroje, datové sady a atributy a spouštět inspekce, například na konci načítání dat. Python SDK používá stejné API.

Tato stránka popisuje, co mají všechny požadavky společné. Stránky jednotlivých zdrojů uvádějí každý koncový bod s jeho parametry, tělem požadavku, odpověďmi a schématy:

Základní URL¶

API je součástí backendu digna. Každá cesta začíná /v1, které následuje za adresou backendu:

https://digna.example.com/v1/projects

Adresa backendu je stejná, jakou používá dashboard: baseUrl v sekci [api] souboru dashboard/dashboard_config.toml. Používejte HTTPS vždy, když volající a digna neběží na stejném počítači, protože každý požadavek nese klíč API.

Ověřování¶

Každý požadavek posílá klíč API uživatele digna v hlavičce Authorization:

Authorization: Bearer <api key>

Klíč vytvoříte tak, že otevřete svůj uživatelský profil v levém dolním rohu dashboardu, kliknete na API Keys, poté na Add API Key a klíč zkopírujete. Zobrazí se pouze jednou. Stejné klíče fungují i pro digna MCP Server.

Požadavek se provádí s oprávněními uživatele, kterému klíč patří. Vytváření, změny a mazání vyžadují v projektu roli editor; jinak je požadavek odmítnut s kódem 403 a zprávou You don't have permission to edit this project.

Odeslání požadavku¶

export DIGNA_API_KEY='<api key>'
curl https://digna.example.com/v1/projects -H "Authorization: Bearer $DIGNA_API_KEY"

Odpovědi jsou ve formátu JSON. Seznamy se vracejí jako pole JSON. Těla požadavků jsou rovněž ve formátu JSON a posílají se s hlavičkou Content-Type: application/json.

Limity a filtry¶

Koncové body vracející seznamy vrátí nejvýše limit položek: ve výchozím nastavení 200, maximálně 5000. Hodnota mimo tento rozsah je odmítnuta s kódem 400. Neexistuje žádný offset ani token stránky, proto seznam zužujte jeho filtry, například project_id, data_source_id nebo start_date a end_date u stavů inspekcí.

Požadavek, který trvá déle než 60 sekund, je zrušen s 408 Request Timeout.

Chyby¶

Chybová odpověď má tělo JSON s kódem a zprávou:

{
  "code": "NOT_FOUND",
  "message": "Data set not found"
}

Pole message odpovědi 401 uvádí, co je s klíčem špatně:

Spuštění inspekce¶

Typická integrace spustí inspekci po dokončení načítání dat, počká na její dokončení a přečte výsledek:

1. Spusťte inspekci pomocí POST /v1/inspection-requests. Odpověď obsahuje id požadavku.
2. Sledujte její průběh pomocí GET /v1/inspection-requests/{inspection_request_id}. Její status přechází z PENDING přes RUNNING do COMPLETED, nebo skončí jako FAILED, ABORTED či CANCELLED. Dotazujte se znovu každých několik sekund, dokud se přestane měnit.
3. Přečtěte výsledek pomocí GET /v1/inspection-statuses/data-sources pro dny, které inspekce zpracovala. Každá položka má celkový status: 0 (OK), 1 (varování), 2 (kritický) nebo -1 (bez stavu), a stav pro každý modul s počtem úspěšných, nejistých a neúspěšných kontrol.

curl -X POST https://digna.example.com/v1/inspection-requests \
  -H "Authorization: Bearer $DIGNA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "project_id": 1,
    "include_all_data_sources": true,
    "data_source_ids": [],
    "start_date": "2026-11-06",
    "end_date": "2026-11-06",
    "mode": "DAILY",
    "weekly_mode_weekdays": [],
    "monthly_mode_days": [],
    "use_notification": true
  }'

Dokument OpenAPI¶

Každá instalace digna popisuje toto API v dokumentu OpenAPI 3.1 a nabízí interaktivní Swagger UI, ve kterém si můžete požadavky vyzkoušet:

Dokument pro Release 2026.11 je k dispozici také zde: openapi.json. Můžete z něj vygenerovat klienta v jiném jazyce.