digna REST API 2026.11¶

API-ul REST digna permite instrumentelor și pipeline-urilor dvs. să lucreze cu digna prin HTTP și JSON: să citească proiecte și rezultate ale inspecțiilor, să gestioneze surse de date, seturi de date și atribute și să pornească inspecții, de exemplu la finalul unei încărcări de date. Python SDK folosește același API.

Această pagină descrie ce au în comun toate cererile. Paginile de resurse prezintă fiecare punct final cu parametrii, corpul cererii, răspunsurile și schemele sale:

URL de bază¶

API-ul face parte din backend-ul digna. Fiecare cale începe cu /v1, după adresa backend-ului:

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

Adresa backend-ului este cea pe care o folosește dashboard-ul: baseUrl din secțiunea [api] a fișierului dashboard/dashboard_config.toml. Folosiți HTTPS ori de câte ori apelantul și digna nu se află pe aceeași mașină, deoarece fiecare cerere conține o cheie API.

Autentificare¶

Fiecare cerere trimite cheia API a unui utilizator digna în antetul Authorization:

Authorization: Bearer <api key>

Pentru a crea o cheie, deschideți profilul de utilizator din colțul din stânga jos al dashboard-ului, faceți clic pe API Keys, apoi pe Add API Key și copiați cheia. Aceasta este afișată o singură dată. Aceleași chei funcționează și pentru digna MCP Server.

O cerere rulează cu permisiunile utilizatorului căruia îi aparține cheia. Crearea, modificarea și ștergerea necesită rolul de editor în proiect; în caz contrar, cererea este refuzată cu 403 și mesajul You don't have permission to edit this project.

Trimiterea unei cereri¶

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

Răspunsurile sunt în format JSON. Listele sunt returnate ca tablou JSON. Corpurile cererilor sunt tot în format JSON și se trimit cu Content-Type: application/json.

Limite și filtre¶

Punctele finale de listare returnează cel mult limit elemente: implicit 200 și până la 5000. O valoare în afara acestui interval este respinsă cu 400. Nu există offset sau token de pagină, așa că restrângeți o listă cu ajutorul filtrelor sale, de exemplu project_id, data_source_id sau start_date și end_date la stările inspecțiilor.

O cerere care durează mai mult de 60 de secunde este anulată cu 408 Request Timeout.

Erori¶

Un răspuns de eroare are un corp JSON cu un cod și un mesaj:

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

Câmpul message al unui răspuns 401 arată ce este în neregulă cu cheia:

Rularea unei inspecții¶

O integrare tipică pornește o inspecție după ce s-a încheiat o încărcare de date, așteaptă finalizarea ei și citește rezultatul:

1. Porniți inspecția cu POST /v1/inspection-requests. Răspunsul conține id-ul cererii.
2. Urmăriți progresul cu GET /v1/inspection-requests/{inspection_request_id}. Câmpul status trece de la PENDING prin RUNNING la COMPLETED sau se încheie ca FAILED, ABORTED ori CANCELLED. Interogați din nou la câteva secunde, până când nu se mai schimbă.
3. Citiți rezultatul cu GET /v1/inspection-statuses/data-sources pentru zilele inspectate. Fiecare element are un status general: 0 (OK), 1 (avertisment), 2 (critic) sau -1 (fără stare), precum și o stare pentru fiecare modul, cu numărul de verificări reușite, incerte și eșuate.

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

Documentul OpenAPI¶

Fiecare instalare digna descrie acest API într-un document OpenAPI 3.1 și oferă o interfață interactivă Swagger UI în care puteți încerca cereri:

Documentul pentru Release 2026.11 este disponibil și aici: openapi.json. Folosiți-l pentru a genera un client în alt limbaj de programare.