digna REST API 2026.11¶

Το REST API του digna επιτρέπει στα δικά σας εργαλεία και pipelines να συνεργάζονται με το digna μέσω HTTP και JSON: να διαβάζουν projects και αποτελέσματα επιθεωρήσεων, να διαχειρίζονται πηγές δεδομένων, σύνολα δεδομένων και χαρακτηριστικά και να ξεκινούν επιθεωρήσεις, για παράδειγμα στο τέλος μιας φόρτωσης δεδομένων. Το Python SDK χρησιμοποιεί το ίδιο API.

Αυτή η σελίδα καλύπτει ό,τι έχουν κοινό όλα τα αιτήματα. Οι σελίδες των πόρων παραθέτουν κάθε endpoint με τις παραμέτρους, το σώμα αιτήματος, τις αποκρίσεις και τα σχήματά του:

Βασικό URL¶

Το API είναι μέρος του backend του digna. Κάθε διαδρομή ξεκινά με /v1, μετά τη διεύθυνση του backend:

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

Η διεύθυνση του backend είναι αυτή που χρησιμοποιεί το dashboard: το baseUrl στην ενότητα [api] του dashboard/dashboard_config.toml. Χρησιμοποιείτε HTTPS όποτε ο καλών και το digna δεν βρίσκονται στο ίδιο μηχάνημα, επειδή κάθε αίτημα μεταφέρει ένα κλειδί API.

Αυθεντικοποίηση¶

Κάθε αίτημα στέλνει το κλειδί API ενός χρήστη digna στην κεφαλίδα Authorization:

Authorization: Bearer <api key>

Για να δημιουργήσετε ένα κλειδί, ανοίξτε το προφίλ χρήστη σας στην κάτω αριστερή γωνία του dashboard, κάντε κλικ στο API Keys και μετά στο Add API Key και αντιγράψτε το κλειδί. Εμφανίζεται μόνο μία φορά. Τα ίδια κλειδιά λειτουργούν και για τον digna MCP Server.

Ένα αίτημα εκτελείται με τα δικαιώματα του χρήστη στον οποίο ανήκει το κλειδί. Η δημιουργία, η αλλαγή και η διαγραφή απαιτούν τον ρόλο συντάκτη (editor) στο project· διαφορετικά, το αίτημα απορρίπτεται με 403 και το μήνυμα You don't have permission to edit this project.

Αποστολή αιτήματος¶

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

Οι αποκρίσεις είναι σε JSON. Οι λίστες επιστρέφονται ως πίνακας JSON. Τα σώματα αιτημάτων είναι επίσης σε JSON και αποστέλλονται με Content-Type: application/json.

Όρια και φίλτρα¶

Τα endpoints λιστών επιστρέφουν το πολύ limit στοιχεία: 200 από προεπιλογή και έως 5000. Μια τιμή εκτός αυτού του εύρους απορρίπτεται με 400. Δεν υπάρχει offset ούτε token σελίδας, οπότε περιορίστε μια λίστα με τα φίλτρα της, για παράδειγμα project_id, data_source_id ή start_date και end_date στις καταστάσεις επιθεώρησης.

Ένα αίτημα που διαρκεί περισσότερο από 60 δευτερόλεπτα ακυρώνεται με 408 Request Timeout.

Σφάλματα¶

Μια απόκριση σφάλματος έχει σώμα JSON με έναν κωδικό και ένα μήνυμα:

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

Το message μιας απόκρισης 401 δείχνει τι δεν πάει καλά με το κλειδί:

Εκτέλεση επιθεώρησης¶

Μια τυπική ενσωμάτωση ξεκινά μια επιθεώρηση όταν ολοκληρωθεί μια φόρτωση δεδομένων, περιμένει να τελειώσει και διαβάζει το αποτέλεσμα:

1. Ξεκινήστε την επιθεώρηση με POST /v1/inspection-requests. Η απόκριση περιέχει το id του αιτήματος.
2. Παρακολουθήστε την πρόοδό της με GET /v1/inspection-requests/{inspection_request_id}. Το status της περνά από PENDING μέσω RUNNING σε COMPLETED ή καταλήγει σε FAILED, ABORTED ή CANCELLED. Ρωτήστε ξανά κάθε λίγα δευτερόλεπτα, μέχρι να μην αλλάζει πια.
3. Διαβάστε το αποτέλεσμα με GET /v1/inspection-statuses/data-sources για τις ημερομηνίες που επιθεωρήθηκαν. Κάθε στοιχείο έχει μια συνολική κατάσταση status: 0 (OK), 1 (προειδοποίηση), 2 (κρίσιμη) ή -1 (χωρίς κατάσταση), καθώς και μια κατάσταση ανά module με τον αριθμό των επιτυχημένων, αβέβαιων και αποτυχημένων ελέγχων.

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¶

Κάθε εγκατάσταση του digna περιγράφει αυτό το API σε ένα έγγραφο OpenAPI 3.1 και προσφέρει ένα διαδραστικό Swagger UI για να δοκιμάζετε αιτήματα:

Το έγγραφο του Release 2026.11 είναι επίσης διαθέσιμο εδώ: openapi.json. Χρησιμοποιήστε το για να δημιουργήσετε ένα client σε άλλη γλώσσα προγραμματισμού.