digna REST-API 2026.11¶

Med digna REST-API:t kan dina egna verktyg och pipelines arbeta med digna över HTTP och JSON: läsa projekt och inspektionsresultat, hantera datakällor, dataset och attribut och starta inspektioner, till exempel i slutet av en dataladdning. Python SDK använder samma API.

Den här sidan beskriver det som alla anrop har gemensamt. Resurssidorna listar varje endpoint med dess parametrar, request-body, svar och scheman:

Bas-URL¶

API:t är en del av dignas backend. Varje sökväg börjar med /v1, efter backendens adress:

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

Backendens adress är densamma som dashboarden använder: baseUrl i avsnittet [api] i dashboard/dashboard_config.toml. Använd HTTPS så snart anroparen och digna inte körs på samma maskin, eftersom varje anrop innehåller en API-nyckel.

Autentisering¶

Varje anrop skickar API-nyckeln för en digna-användare i headern Authorization:

Authorization: Bearer <api key>

Skapa en nyckel genom att öppna din användarprofil längst ned till vänster i dashboarden, klicka på API Keys och sedan på Add API Key, och kopiera nyckeln. Den visas bara en gång. Samma nycklar fungerar för digna MCP Server.

Ett anrop körs med behörigheterna för den användare som äger nyckeln. För att skapa, ändra och ta bort krävs editorrollen i projektet; annars avvisas anropet med 403 och meddelandet You don't have permission to edit this project.

Skicka ett anrop¶

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

Svaren är JSON. Listor returneras som en JSON-array. Även request-bodies är JSON och skickas med Content-Type: application/json.

Gränser och filter¶

List-endpoints returnerar högst limit poster: 200 som standard och upp till 5000. Ett värde utanför det intervallet avvisas med 400. Det finns ingen offset eller sidtoken, så avgränsa i stället en lista med dess filter, till exempel project_id, data_source_id, eller start_date och end_date för inspektionsstatusarna.

Ett anrop som tar längre tid än 60 sekunder avbryts med 408 Request Timeout.

Fel¶

Ett felsvar har en JSON-body med en kod och ett meddelande:

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

message i ett 401-svar talar om vad som är fel med nyckeln:

Köra en inspektion¶

En typisk integration startar en inspektion när en dataladdning är klar, väntar på den och läser resultatet:

1. Starta inspektionen med POST /v1/inspection-requests. Svaret innehåller begärans id.
2. Följ dess förlopp med GET /v1/inspection-requests/{inspection_request_id}. Dess status går från PENDING via RUNNING till COMPLETED, eller slutar som FAILED, ABORTED eller CANCELLED. Fråga igen med några sekunders mellanrum tills den inte längre ändras.
3. Läs resultatet med GET /v1/inspection-statuses/data-sources för de inspekterade datumen. Varje post har en övergripande status: 0 (OK), 1 (varning), 2 (kritisk) eller -1 (ingen status), och en status per modul med antalet godkända, osäkra och misslyckade 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¶

Varje digna-installation beskriver detta API i ett OpenAPI 3.1-dokument och erbjuder ett interaktivt Swagger UI där du kan prova anrop mot det:

Dokumentet för Release 2026.11 finns också här: openapi.json. Använd det för att generera en klient i ett annat språk.