digna REST API 2026.11¶

Med digna REST API kan dine egne verktøy og pipelines jobbe med digna over HTTP og JSON: lese prosjekter og inspeksjonsresultater, administrere datakilder, datasett og attributter og starte inspeksjoner, for eksempel når en datalasting er ferdig. Python SDK bruker det samme API-et.

Denne siden beskriver det alle forespørsler har til felles. Ressurssidene viser hvert endepunkt med parametere, forespørselsbody, svar og skjemaer:

Basis-URL¶

API-et er en del av digna-backenden. Hver sti begynner med /v1, etter backendens adresse:

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

Backendens adresse er den samme som dashboardet bruker, baseUrl i [api]-seksjonen i dashboard/dashboard_config.toml. Bruk HTTPS når kallende system og digna ikke er på samme maskin, fordi hver forespørsel inneholder en API-nøkkel.

Autentisering¶

Hver forespørsel sender API-nøkkelen til en digna-bruker i Authorization-headeren:

Authorization: Bearer <api key>

For å opprette en nøkkel åpner du brukerprofilen din nederst til venstre i dashboardet, klikker API Keys og deretter Add API Key, og kopierer nøkkelen. Den vises bare én gang. De samme nøklene fungerer også for digna MCP Server.

En forespørsel kjøres med rettighetene til nøkkelens bruker. Å opprette, endre og slette krever redaktørrollen i prosjektet; ellers avvises forespørselen med 403 og meldingen You don't have permission to edit this project.

Sende en forespørsel¶

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 en JSON-array. Forespørselsbodyer er også JSON og sendes med Content-Type: application/json.

Grenser og filtre¶

Listeendepunkter returnerer høyst limit elementer: 200 som standard og opptil 5000. En verdi utenfor dette området avvises med 400. Det finnes ingen offset eller sidetoken, så snevre i stedet inn en liste med filtrene dens, for eksempel project_id, data_source_id, eller start_date og end_date på inspeksjonsstatusene.

En forespørsel som tar lengre tid enn 60 sekunder, avbrytes med 408 Request Timeout.

Feil¶

Et feilsvar har en JSON-body med en kode og en melding:

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

message i et 401-svar forteller hva som er galt med nøkkelen:

Kjøre en inspeksjon¶

En typisk integrasjon starter en inspeksjon når en datalasting er ferdig, venter på den og leser resultatet:

1. Start inspeksjonen med POST /v1/inspection-requests. Svaret inneholder forespørselens id.
2. Følg fremdriften med GET /v1/inspection-requests/{inspection_request_id}. status går fra PENDING via RUNNING til COMPLETED, eller ender som FAILED, ABORTED eller CANCELLED. Spør på nytt med noen sekunders mellomrom til den ikke lenger endrer seg.
3. Les resultatet med GET /v1/inspection-statuses/data-sources for de inspiserte datoene. Hvert element har en samlet status: 0 (OK), 1 (advarsel), 2 (kritisk) eller -1 (ingen status), og en status per modul med antall beståtte, usikre og mislykkede 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-installasjon beskriver dette API-et i et OpenAPI 3.1-dokument og tilbyr et interaktivt Swagger UI der du kan prøve forespørsler mot det:

Dokumentet for Release 2026.11 er også tilgjengelig her: openapi.json. Bruk det til å generere en klient i et annet språk.