digna REST API 2026.11¶

Med digna REST API kan dine egne værktøjer og pipelines arbejde med digna over HTTP og JSON: læse projekter og inspektionsresultater, administrere datakilder, datasæt og attributter og starte inspektioner, for eksempel når en dataindlæsning er færdig. Python SDK bruger det samme API.

Denne side beskriver det, som alle forespørgsler har til fælles. Ressourcesiderne viser hvert endpoint med parametre, forespørgselsbody, svar og skemaer:

Basis-URL¶

API'et er en del af digna-backenden. Hver sti begynder med /v1 efter backendens adresse:

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

Backendens adresse er den samme, som dashboardet bruger, baseUrl i [api]-sektionen i dashboard/dashboard_config.toml. Brug HTTPS, når det kaldende system og digna ikke er på samme maskine, fordi hver forespørgsel indeholder en API-nøgle.

Godkendelse¶

Hver forespørgsel sender API-nøglen for en digna-bruger i Authorization-headeren:

Authorization: Bearer <api key>

Du opretter en nøgle ved at åbne din brugerprofil i nederste venstre hjørne af dashboardet, klikke på API Keys og derefter Add API Key og kopiere nøglen. Den vises kun én gang. De samme nøgler virker også til digna MCP Server.

En forespørgsel kører med rettighederne for nøglens bruger. Oprettelse, ændring og sletning kræver editorrollen i projektet; ellers afvises forespørgslen med 403 og meddelelsen You don't have permission to edit this project.

Send en forespørgsel¶

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

Svarene er JSON. Lister returneres som et JSON-array. Forespørgselsbodyer er også JSON og sendes med Content-Type: application/json.

Grænser og filtre¶

Listeendpoints returnerer højst limit elementer: 200 som standard og op til 5000. En værdi uden for dette interval afvises med 400. Der findes ingen offset eller sidetoken, så indsnævr i stedet en liste med dens filtre, for eksempel project_id, data_source_id eller start_date og end_date på inspektionsstatusserne.

En forespørgsel, der tager længere end 60 sekunder, annulleres med 408 Request Timeout.

Fejl¶

Et fejlsvar har en JSON-body med en kode og en meddelelse:

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

message i et 401-svar fortæller, hvad der er galt med nøglen:

Kør en inspektion¶

En typisk integration starter en inspektion, når en dataindlæsning er færdig, venter på den og læser resultatet:

1. Start inspektionen med POST /v1/inspection-requests. Svaret indeholder anmodningens id.
2. Følg dens fremdrift med GET /v1/inspection-requests/{inspection_request_id}. Dens status går fra PENDING over RUNNING til COMPLETED eller ender som FAILED, ABORTED eller CANCELLED. Spørg igen med få sekunders mellemrum, indtil den ikke længere ændrer sig.
3. Læs resultatet med GET /v1/inspection-statuses/data-sources for de inspicerede datoer. Hvert element har en samlet status: 0 (OK), 1 (advarsel), 2 (kritisk) eller -1 (ingen status) samt en status pr. modul med antallet af beståede, usikre og fejlede kontroller.

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-dokument¶

Hver digna-installation beskriver dette API i et OpenAPI 3.1-dokument og tilbyder en interaktiv Swagger UI, hvor du kan afprøve forespørgsler mod det:

Dokumentet for Release 2026.11 er også tilgængeligt her: openapi.json. Brug det til at generere en klient i et andet sprog.