digna REST API 2026.11¶

digna REST API leidžia jūsų įrankiams ir duomenų srautams dirbti su digna per HTTP ir JSON: skaityti projektus ir inspekcijų rezultatus, valdyti duomenų šaltinius, duomenų rinkinius ir atributus bei paleisti inspekcijas, pavyzdžiui, pasibaigus duomenų įkėlimui. Python SDK naudoja tą pačią API.

Šiame puslapyje aprašoma tai, kas bendra visoms užklausoms. Išteklių puslapiuose pateikiamas kiekvienas galinis taškas su jo parametrais, užklausos turiniu, atsakymais ir schemomis:

Bazinis URL¶

API yra digna backend'o dalis. Kiekvienas kelias prasideda /v1 po backend'o adreso:

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

Backend'o adresas yra tas pats, kurį naudoja dashboard: baseUrl failo dashboard/dashboard_config.toml skyriuje [api]. Naudokite HTTPS visada, kai kviečianti sistema ir digna veikia ne tame pačiame kompiuteryje, nes kiekvienoje užklausoje yra API raktas.

Autentifikavimas¶

Kiekviena užklausa siunčia digna vartotojo API raktą antraštėje Authorization:

Authorization: Bearer <api key>

Norėdami sukurti raktą, apatiniame kairiajame dashboard kampe atidarykite savo vartotojo profilį, spauskite API Keys, tada Add API Key, ir nukopijuokite raktą. Jis rodomas tik vieną kartą. Tie patys raktai tinka ir digna MCP Server.

Užklausa vykdoma su rakto vartotojo teisėmis. Kuriant, keičiant ir šalinant projekte reikia redaktoriaus rolės; kitaip užklausa atmetama su 403 ir pranešimu You don't have permission to edit this project.

Užklausos siuntimas¶

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

Atsakymai pateikiami JSON formatu. Sąrašai grąžinami kaip JSON masyvas. Užklausų turinys taip pat yra JSON ir siunčiamas su Content-Type: application/json.

Ribos ir filtrai¶

Sąrašų galiniai taškai grąžina ne daugiau kaip limit elementų: pagal numatymą 200, daugiausia 5000. Reikšmė už šio intervalo ribų atmetama su 400. Poslinkio (offset) ar puslapio žetono nėra, todėl sąrašą siaurinkite jo filtrais, pavyzdžiui, project_id, data_source_id arba inspekcijų būsenų start_date ir end_date.

Užklausa, trunkanti ilgiau nei 60 sekundžių, nutraukiama su 408 Request Timeout.

Klaidos¶

Klaidos atsakymas turi JSON turinį su kodu ir pranešimu:

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

401 atsakymo message nurodo, kas negerai su raktu:

Inspekcijos paleidimas¶

Įprasta integracija paleidžia inspekciją, kai baigiasi duomenų įkėlimas, palaukia, kol ji baigsis, ir nuskaito rezultatą:

1. Paleiskite inspekciją užklausa POST /v1/inspection-requests. Atsakyme yra užklausos id.
2. Stebėkite jos eigą užklausa GET /v1/inspection-requests/{inspection_request_id}. Jos status pereina iš PENDING per RUNNING į COMPLETED arba baigiasi būsena FAILED, ABORTED ar CANCELLED. Klauskite pakartotinai kas kelias sekundes, kol būsena nebesikeis.
3. Nuskaitykite rezultatą užklausa GET /v1/inspection-statuses/data-sources inspektuotoms datoms. Kiekvienas elementas turi bendrą status: 0 (OK), 1 (įspėjimas), 2 (kritinė) arba -1 (būsenos nėra), ir kiekvieno modulio būseną su sėkmingų, neapibrėžtų ir nepavykusių patikrų skaičiumi.

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

Kiekviena digna diegtis aprašo šią API OpenAPI 3.1 dokumente ir siūlo interaktyvią Swagger UI, kurioje galite išbandyti užklausas:

Release 2026.11 dokumentas taip pat pasiekiamas čia: openapi.json. Naudokite jį klientui kita programavimo kalba sugeneruoti.