Open Data Portal API: automatisierter Datenverbrauch

Wissen Sie, was eine API ist?

Anwendungsprogrammierschnittstellen (APIs) gehören zu den gebräuchlichsten Diensten für den Informationsaustausch und Datenzugriff, die heute verfügbar sind.

Sie ergänzen die Verfügbarkeit von Daten in herunterladbaren Dateien und bieten eine Reihe von Vorteilen, die sie zu einem wesentlichen Mittel für den Zugang zu und die Nutzung von Daten in jeder Open-Data-Initiative machen.

Darüber hinaus ist es der am besten geeignete Zugangsmechanismus für die Veröffentlichung von Daten mit einer hohen Aktualisierungsfrequenz, wie Echtzeitdaten (Wetter-API) oder Daten des öffentlichen Verkehrs, die als besonders wertvoll gelten (Durchführungsverordnung (EU) 2023/138 der Kommission vom 21. Dezember 2022 zur Festlegung einer Liste spezifischer hochwertiger Datensätze und der Modalitäten ihrer Veröffentlichung und Weiterverwendung).

APIs sind besonders nützlich, um alle Arten von Daten automatisch zu konsumieren und können den Download auf die gewünschten Daten abstimmen.

Welche Vorteile bietet die Nutzung der Daten-API des Open Data Portal?

Ein Vorteil von APIs gegenüber dem Herunterladen von Dateien besteht darin, dass sie verschiedene Operationen beim Datenzugriff und -abruf ermöglichen. Beim Abruf von Daten über APIs ist es üblich, Daten zu filtern und Kategorien oder Formate auszuwählen.

In diesem Artikel werden wir die Funktionsweise und die Möglichkeit der Wiederverwendung des Inhalts des Open-Data-Portals des Cabildo de Tenerife dank seiner Verwendung näher betrachten.

Wie verwendet man die API von datos.tenerife.es?

Die Dokumentation über die API des Portals Cabildo de Tenerife Open Data finden Sie im Datenblock oben auf der Portalseite. Wenn Sie auf den Abschnitt APIzugreifen , sehen Sie den folgenden Bildschirm:

In den APIs erfolgt die Kommunikation zwischen Server und Clients im Web durch den Austausch von HTTP-Nachrichten in einem sicheren Interaktionskontext.

Es gibt zwei Arten von Nachrichten: Anfragen, die vom Client an den Server gesendet werden, um die Einleitung einer Aktion zur Interaktion mit den Informationsressourcen anzufordern, und Antworten, die die Umsetzung der angeforderten Aktion darstellen.

Jede Anfrage enthält, wie wir weiter unten sehen werden, alle Informationen, die zur Ausführung der angeforderten Aktion erforderlich sind. Im Open-Data-Portal des Cabildo verwenden die Operationen oder Aktionen, die durchgeführt werden können, die Methode "GET" für verschiedene Arten von Objekten:

• Datensätze
• Ressourcen
• Kategorien
• Organisationen
• Schlagwörter

Datensatz-Operationen

Die API ermöglicht es Ihnen, die Liste der im Portal veröffentlichten Datensätze zu erhalten; den Aktivitätsfluss all derjenigen, die kürzlich - am letzten Tag - hinzugefügt oder geändert wurden; die Informationen derjenigen Datensätze, die zu einer Kategorie gehören; die Datensätze, die einem bestimmten Suchkriterium entsprechen oder die Metadatenbeziehung eines Datensatzes und seiner Ressourcen.

Um eine konkrete Antwort zu erhalten, müssten zunächst die gewünschten Parameter festgelegt werden. In diesem Fall würden wir mit der ersten Operation beginnen, die der Liste der vorhandenen Datensätze im Portalkatalog entspricht.

Nachdem man auf GET oder den Pfeil ganz rechts geklickt hat, muss man die Aktionen "Ausprobieren" und "Ausführen" starten, um den Inhalt der Anfrage auszuführen. Auf diese Weise wird zuerst die auszuführende Anfrage angezeigt.

Anschließend wird die Antwort angezeigt, die eine Liste aller Datensätze enthält, die auch heruntergeladen werden können.

Die URL der Anfrage liefert eine Liste der im Open-Data-Portal verfügbaren Datensätze - im JSON-Format -, ohne dass man auf das Portal zugreifen muss. Mit der gleichen URL können Sie die Daten in aktualisierter Form verfügbar machen, indem Sie sie in Ihren eigenen Browser einfügen.

Wie kann ich Parameter einstellen, um spezifische Ergebnisse zu erhalten?

Um die erhaltenen Datensätze spezifisch zu segmentieren, können Sie bei jedem Vorgang einen der vorhandenen Parameter auswählen, um diejenigen zu erhalten, die zu einer bestimmten Kategorie gehören, die einem bestimmten Suchkriterium entsprechen oder die bestimmte Metadaten enthalten.

Bei Datensätzen, die zu einer Kategorie gehören (/action/group_package_show) , ist die Angabe einer ID obligatorisch.

Diese "id" entspricht den verschiedenen Kategorien des Portals, die auch "Gruppen" genannt werden. Um herauszufinden, welche Kategorie Ihrer Suche am nächsten kommt, können Sie die auf der Startseite des Portals aufgeführten Kategorien konsultieren. Sie können aber auch, ohne die aktuelle Seite zu verlassen, über die Operation "Kategorien" (/action/group_list) abgerufen werden, die alle Kategorien des Portals liefert (unabhängig davon, ob sie Datensätze enthalten oder nicht) .

Klicken Sie zunächst auf "Try it out" und dann auf "Execute", um die entsprechende Liste zu erhalten. In diesem Bild wird die Liste der "id" der verschiedenen vorhandenen Kategorien angezeigt.

Nachdem Sie die entsprechenden "IDs" erhalten haben, wählen Sie diejenige aus, die der gewünschten Antwort am nächsten kommt, und geben Sie sie in das entsprechende Feld ein, wie oben angegeben.

Auf diese Weise werden in den Ergebnissen alle Datensätze angezeigt, die mit dieser Kategorie zusammenhängen. Im folgenden Beispiel geben wir "Handel" an, um die erhaltenen Ergebnisse zu visualisieren.

Im Feld "Limit" können Sie die maximale Anzahl der Datensätzeangeben , die Sie pro Kategorie erhalten möchten (standardmäßig 10).

Dieser Vorgang ermöglicht es, die Liste der spezifischen und aktualisierten Datensätze zu erhalten, was ihre Wiederverwendung erleichtern kann.

Mit der folgenden Operation (/action/package_search) kann eine Suche nach einem Datensatz durchgeführt werden, der ein bestimmtes Suchkriterium erfüllt. In diesem Fall werden verschiedene Parameter angezeigt.

Im Feld "q" können die Daten mit der Solr-Suchsyntax abgefragt werden. Hierfür werden Codes wie "Tags", "Gruppen" oder "Organisation" verwendet, gefolgt von einem Doppelpunkt und dem entsprechenden Wort. In diesem Feld kann auch eine einfache Suche durchgeführt werden, bei der das Wort direkt und ohne Codes verwendet wird.

Wenn Sie zum Beispiel "tags:restaurants" eingeben, werden die Datensätze angezeigt, in denen dieses Wort als Tag enthalten ist.

Auf dieselbe Weise können Sie die Suche auch nach Organisation ("organisation") oder nach Kategorie ("groups") eingrenzen, wie im Beispiel "organisation:transport-inter-urban-transport-from-tenerife-titsa".

Wie erhält man Metadaten von einem Datensatz und seinen Ressourcen?

Eine weitere Möglichkeit, die die API bietet, besteht darin, die Metadaten eines bestimmten Datensatzes und seiner Ressourcen zu erhalten (/action/package_show). Zunächst muss man die "id" oder den "Namen" des abzufragenden Datensatzes kennen, wofür man eine der vorherigen Operationen verwenden kann, in deren Ergebnissen man den Namen und/oder die Kennung der resultierenden Datensätze finden kann.

Aus dem vorangegangenen Beispiel können wir mit der Operation /action/package_search die entsprechende "id" oder "name" des Datensatzesauswählen , von dem wir seine Metadaten speziell erhalten wollen (für das vorangegangene Beispiel "Restaurants"):

In diesem Fall würden wir also über die "id" (4912b6d8-89f3-48d7-9dd1-bdefb18dbb17) oder den "name" (establecimientos-de-hosteleria-y-restauracion-de-tenerife) die Metadaten des Datensatzes und seiner Ressourcen erhalten.

Auf diese Weise erhält man die entsprechende Liste mit der URL, über die man die aktualisierten Daten abrufen kann, wie in den oben beschriebenen Beispielen.

Wenn wir in der API-Dokumentation weiter vorankommen, werden wir andere Operationen oder Aktionen sehen, die wie folgt angegeben sind

/action/tag_list

/Aktion/Tag_Anzeigen

/Aktion/Organisation_Anzeigen

/Aktion/Ressourcen_anzeigen

In diesen Fällen können sie auf die gleiche Weise ausgeführt werden wie die oben genannten.

Soweit eine kurze Erklärung, in der wir einige der Möglichkeiten der Katalog-API des Open Data Portals des Cabildo de Tenerife aufzeigen. Es ist klar, dass APIs wesentliche Werkzeuge sind, um in der digitalen Welt effizient und programmatisch auf Daten zuzugreifen und diese zu teilen.

Es bleibt Ihnen also nur noch, mehr auf unserem eigenen Portal datos.tenerife.eszu entdecken .