Δημιουργία περιγραφής API

Το data.gov.gr υποστηρίζει τη δημοσίευση Data Services (Υπηρεσιών Δεδομένων) σύμφωνα με το ευρωπαϊκό πρότυπο DCAT-AP, δίπλα στα σύνολα δεδομένων.

Ένα Data Service είναι μια υπηρεσία που παρέχει πρόσβαση σε δεδομένα μέσω προγραμματιστικών διεπαφών (APIs).

Με αυτόν τον τρόπο κάθε φορέας μπορεί να καταχωρεί APIs ή άλλες υπηρεσίες διάθεσης δεδομένων, ώστε να είναι εύκολα ανιχνεύσιμες και επαναχρησιμοποιήσιμες από τους καταναλωτές και οι χρήστες να έχουν πρόσβαση σε μηχανικά αναγνώσιμες υπηρεσίες δεδομένων.

Πώς θα ξεκινήσετε

Για να δημιουργήσετε μια νέα περιγραφή Data Service έχετε δύο επιλογές:

  1. Μέσα από το κεντρικό μενού

    • Επιλέξτε APIs → Δημιουργία περιγραφής API.

    • Πατήστε New Data Service.

  2. Μέσα από το προφίλ του οργανισμού σας

    • Μεταβείτε στο προφίλ του οργανισμού.

    • Επιλέξτε την καρτέλα Σύνολα Δεδομένων / APIs.

    • Πατήστε Προσθήκη και επιλέξτε Data Service.

    • Το πεδίο του οργανισμού (ιδιοκτήτη) θα συμπληρωθεί αυτόματα.

Σημείωση: Μόνο οι Εκδότες και οι Διαχειριστές οργανισμού έχουν δικαίωμα να δημιουργούν Data Services για τον συγκεκριμένο οργανισμό.

Συμπλήρωση Πεδίων

Η φόρμα δημιουργίας Data Service περιλαμβάνει τα παρακάτω πεδία:

  • Τίτλος (υποχρεωτικό): Το όνομα της υπηρεσίας.

  • Περιγραφή: Σύντομη περιγραφή του τι προσφέρει το Data Service.

  • Λέξεις-κλειδιά (Tags): Όροι που διευκολύνουν την αναζήτηση (π.χ. “api”, “φορολογικό”, “υγεία”).

  • Οργανισμός: Ο φορέας που είναι υπεύθυνος εντός του data.gov.gr για τη δημοσίευση, διαχείριση και ενημέρωση της περιγραφής του Data Service. Δεν ταυτίζεται απαραίτητα με τον πραγματικό εκδότη της υπηρεσίας· σε περίπτωση που ο εκδότης είναι διαφορετικός, αυτός δηλώνεται ρητά στο πεδίο Εκδότης.

  • Ορατότητα:

    • Δημόσιο: διαθέσιμο σε όλους.

    • Ιδιωτικό: διαθέσιμο μόνο στα μέλη του οργανισμού.

Εκδότης

Στοιχεία του πραγματικού εκδότη (φορέα ή οργανισμού) που παρέχει το Data Service.

  • Αν ο εκδότης είναι ο ίδιος με τον οργανισμό που επιλέχθηκε στο αντίστοιχο πεδίο, δεν είναι απαραίτητη η συμπλήρωση.

  • Συμπληρώνεται μόνο στην περίπτωση που το Data Service δημοσιεύεται στο data.gov.gr από διαφορετικό οργανισμό από αυτόν που το παρέχει (π.χ. το ΚΕΔ διαχειρίζεται υπηρεσίες που παρέχονται από την ΑΑΔΕ).

Πεδία Εκδότη:

  • URI: Αναγνωριστικό του εκδότη (π.χ. ROR ID).

  • Όνομα: Ονομασία του εκδότη.

  • Email: Στοιχείο επικοινωνίας.

  • URL: Ιστοσελίδα του εκδότη.

  • Publisher Type: Τύπος εκδότη, επιλογή από ελεγχόμενο λεξιλόγιο ADMS-AP.

  • Identifier: Μοναδικό αναγνωριστικό.

Σημεία Πρόσβασης (Endpoints)

URLs και περιγραφές για τα endpoints της υπηρεσίας.

  • Endpoint URL (υποχρεωτικό): Η βασική διεύθυνση πρόσβασης της υπηρεσίας.

  • Περιγραφή Σημείου Πρόσβασης: Περιγραφή της λειτουργικότητας του endpoint.

Σημεία Επαφής (Contact Point)

Στοιχεία επικοινωνίας για υποστήριξη ή διευκρινίσεις:

  • URI: Αναγνωριστικό.

  • Όνομα: Υπεύθυνος επαφής.

  • Email: Email επικοινωνίας.

  • URL: Ιστοσελίδα επαφής.

Επιπλέον Πεδία

  • Δικαιώματα Πρόσβασης: Πληροφορίες για περιορισμούς ή πολιτικές ασφάλειας (επιλογή από ελεγχόμενο λεξιλόγιο).

  • Εφαρμοστέα Νομοθεσία: Νομοθεσία που καθορίζει το πλαίσιο διάθεσης.

  • Θεματική Κατηγορία: Επιλογή από το ελεγχόμενο λεξιλόγιο DCAT-AP data themes.

  • Άδεια: Δήλωση άδειας χρήσης (επιλογή από ελεγχόμενο λεξιλόγιο αδειών).

  • Δικαιώματα: Συμπληρωματικές πληροφορίες για τα δικαιώματα.

  • Μορφότυποι: Τύποι δεδομένων που εξυπηρετεί η API (π.χ. JSON, XML) — επιλογή από ελεγχόμενο λεξιλόγιο file types.

  • Σελίδα Προορισμού: Ιστοσελίδα με επιπλέον πληροφορίες.

  • Τεκμηρίωση: URL ή αρχείο με οδηγίες χρήσης.

Ειδική Περίπτωση: HVD APIs

Σύμφωνα με το πρότυπο DCAT-AP HVD, για να θεωρείται ένα Data Service ότι περιγράφει σύνολο δεδομένων υψηλής αξίας, καλό είναι να συμπληρωθούν τα πρόσθετα πεδία ώστε:

  • να συμφωνεί απόλυτα με το πρότυπο,

  • να υπάρχει πληρέστερη περιγραφή και πιο πλούσια μεταδεδομένα.

Τα πρόσθετα πεδία είναι:

  • Εφαρμοστέα Νομοθεσία

  • Σημεία Επαφής

  • Τεκμηρίωση

  • Κατηγορία Συνόλων Δεδομένων Υψηλής Αξίας (HVD Category) → επιλογή από το αντίστοιχο λεξιλόγιο.

Η συμπλήρωση της Κατηγορίας HVD είναι και το στοιχείο που σηματοδοτεί ότι το συγκεκριμένο Data Service αποτελεί HVD API και το διαφοροποιεί από τα υπόλοιπα.

Υποχρεωτικά Πεδία – Σύγκριση

Πεδίο
Γενική Περίπτωση
HVD API

Τίτλος

Υποχρεωτικό

Υποχρεωτικό

Endpoint URL

Υποχρεωτικό

Υποχρεωτικό

Εφαρμοστέα Νομοθεσία

Προαιρετικό

Προτείνεται

Σημεία Επαφής

Προαιρετικό

Προτείνεται

Τεκμηρίωση

Προαιρετικό

Προτείνεται

Κατηγορία HVD

Δεν ισχύει

Προτείνεται

Ολοκλήρωση

Αφού συμπληρώσετε όλα τα υποχρεωτικά πεδία, πατήστε Αποθήκευση.

  • Το νέο Data Service θα εμφανιστεί στη λίστα APIs του οργανισμού σας.

  • Η ορατότητα θα είναι αυτή που έχετε ορίσει (Δημόσιο ή Ιδιωτικό).

Σημειώσεις

  • Η χρήση ελεγχόμενων λεξιλογίων (π.χ. για Άδεια, Δικαιώματα Πρόσβασης, Μορφότυπους, Publisher Type, HVD Category) εξασφαλίζει τυποποίηση και διαλειτουργικότητα.

  • Για περισσότερες πληροφορίες σχετικά με τα ελεγχόμενα λεξιλόγια: 🔗 Οδηγοί data.gov.gr – Λεξιλόγια

🔗 Χρήσιμες παραπομπές:

PreviousAPIsNextΣύνδεση Data Service με Dataset

Last updated