digna REST API 2026.11¶

A digna REST API-jával saját eszközei és pipeline-jai HTTP-n és JSON-on keresztül dolgozhatnak a digna rendszerrel: projekteket és inspekciós eredményeket olvashatnak, adatforrásokat, adathalmazokat és attribútumokat kezelhetnek, és inspekciókat indíthatnak, például egy adatbetöltés végén. A Python SDK ugyanezt az API-t használja.

Ez az oldal azt ismerteti, ami minden kérésben közös. Az erőforrásoldalak minden végpontot felsorolnak a paramétereivel, a kérés törzsével, a válaszokkal és a sémákkal együtt:

Alap URL¶

Az API a digna backend része. Minden útvonal /v1 előtaggal kezdődik, a backend címe után:

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

A backend címe ugyanaz, amelyet a dashboard is használ: a dashboard/dashboard_config.toml fájl [api] szakaszában megadott baseUrl. Használjon HTTPS-t, ha a hívó fél és a digna nem ugyanazon a gépen fut, mert minden kérés API-kulcsot tartalmaz.

Hitelesítés¶

Minden kérés egy digna felhasználó API-kulcsát küldi el az Authorization fejlécben:

Authorization: Bearer <api key>

Kulcs létrehozásához nyissa meg a felhasználói profilját a dashboard bal alsó sarkában, kattintson az API Keys, majd az Add API Key elemre, és másolja ki a kulcsot. A kulcs csak egyszer jelenik meg. Ugyanezek a kulcsok a digna MCP Server esetében is működnek.

A kérés a kulcshoz tartozó felhasználó jogosultságaival fut. A létrehozáshoz, módosításhoz és törléshez editor szerepkör szükséges a projektben; ellenkező esetben a rendszer a kérést 403 kóddal és a You don't have permission to edit this project üzenettel elutasítja.

Kérés küldése¶

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

A válaszok JSON formátumúak. A listák JSON-tömbként érkeznek. A kéréstörzsek szintén JSON formátumúak, és Content-Type: application/json fejléccel kell elküldeni őket.

Korlátok és szűrők¶

A listázó végpontok legfeljebb limit elemet adnak vissza: alapértelmezés szerint 200-at, de legfeljebb 5000-et. Az e tartományon kívüli értéket a rendszer 400 kóddal elutasítja. Nincs eltolás (offset) és oldaltoken, ezért a listát a szűrőivel szűkítse, például a project_id, a data_source_id, illetve az inspekciós állapotoknál a start_date és az end_date segítségével.

A 60 másodpercnél tovább tartó kérést a rendszer 408 Request Timeout válasszal megszakítja.

Hibák¶

A hibaválasz JSON-törzse egy kódot és egy üzenetet tartalmaz:

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

Egy 401 válasz message mezője megmondja, mi a probléma a kulccsal:

Inspekció futtatása¶

Egy tipikus integráció egy adatbetöltés befejeztével elindít egy inspekciót, megvárja a végét, majd beolvassa az eredményt:

1. Indítsa el az inspekciót a POST /v1/inspection-requests hívással. A válasz tartalmazza a kérés id azonosítóját.
2. Kövesse az előrehaladását a GET /v1/inspection-requests/{inspection_request_id} hívással. A status értéke PENDING értékről RUNNING értéken át COMPLETED értékre vált, vagy FAILED, ABORTED vagy CANCELLED értékkel zárul. Néhány másodpercenként kérdezze le újra, amíg már nem változik.
3. Olvassa be az eredményt a GET /v1/inspection-statuses/data-sources hívással a vizsgált napokra. Minden elemnek van egy összesített status értéke: 0 (OK), 1 (figyelmeztetés), 2 (kritikus) vagy -1 (nincs állapot), valamint modulonként egy állapota a sikeres, bizonytalan és sikertelen ellenőrzések számával.

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
  }'

OpenAPI-dokumentum¶

Minden digna telepítés egy OpenAPI 3.1 dokumentumban írja le ezt az API-t, és interaktív Swagger UI-t kínál, amelyben kipróbálhatók a kérések:

A Release 2026.11 dokumentuma itt is elérhető: openapi.json. Ezzel klienst generálhat más programozási nyelvre.