Verwenden der API

Eine API (Application Programming Interface bzw. Programmierschnittstelle) ist eine Schnittstelle für Programme zur Kommunikation und zum Datenaustausch.

Hinweis

Um mehr darüber zu erfahren, was APIs sind und warum und wie sie verwendet werden, können Sie den folgenden Artikel lesen, der von einem unserer OpenDataSoft-Entwickler geschrieben wurde: <https://kitchen.opendatasoft.com/you-dont-need-analogies-to-understand-apis-14da4513f970>`_”

OpenDataSoft bietet Zugriff auf 6 APIs, die in 3 Kategorien eingeteilt werden können:

All diese APIs bieten Zugriff auf alle Daten, die auf die Plattform übertragen werden, unabhängig von ihrer Quelle oder ihrem Format. Einzige Voraussetzung ist, dass die vom Dateneigner definierten Sicherheitsregeln diesen Zugriff erlauben.

Diese APIs können beispielsweise dazu verwendet werden, um nach Datensätzen und Daten zu suchen, Analysen zu berechnen oder geografische Aggregationen durchzuführen. Ebenfalls entwicklerorientiert, jedoch konkretere Beispiele für den Einsatz von APIs sind Anwendungen als Daten-Weiterverwendungen. So wurden die Datensätze einiger OpenDataSoft-Kunden über ihre API wiederverwendet, um neue Anwendungen zu entwickeln (z. B.: Qui dit miam ! und Y’A D Frites! 2 Anwendungen, die die Menüs der Schulkantinen der französischen Städte Toulouse, Rennes und Saint-Malo anzeigen.)

Wichtig

Vor der Verwendung einer der verfügbaren APIs ist es sehr wichtig, mit der Art dieser Daten vertraut zu sein. Alles auf der Plattform ist nach einer Baumstruktur aufgebaut (es gibt natürlich mehre Datentypen auf der Plattform, aber sie sind nur in sehr spezifischen Kontexten relevant). OpenDataSoft kann also folgendermaßen verstanden werden:

  • Die OpenDataSoft-Plattform ist ein Netzwerk aus mehreren OpenDataSoft-Portalen.

  • Ein Portal stellt einen Katalog aller seiner Datensätze bereit.

  • Jeder Datensatz wird durch ein Metadaten-Wörterbuch, ein Datenschema (das Feldnamen und -typen angibt) und eine Sammlung an Einträgen definiert.

  • Jeder Eintrag bietet Werte für jedes einzelne Datensatzfeld.

Triple Pattern Fragments

Die Triple Pattern Fragments (TPF) API ermöglicht die Abfrage von Datensätzen im Resource Description Framework (RDF) Format. Die Arbeit an diesem Projekt läuft noch und ist Teil einer Dissertation, die das Ziel verfolgt, die Qualität der Datensätze von OpenDataSoft unter Einsatz von semantischen Web-Technologien zu verbessern.

OData, WFS und CSW

OData, WFS und CSW beziehen sich auf weitere Standards, die von der Plattform implementiert werden. Nutzer, die nicht mit diesen Standards nicht vertraut sind, sollten bei der ODS Search API bleiben, da sie den umfassendsten Zugang zu den Daten bietet.

  • OData: Standard für REST-APIs, die eine gemeinsame, API-übergreifende Sprache zur Durchführung von Anfragen bieten. Der generische Ansatz dieser Norm hat zugleich eine höhere Komplexität im Vergleich zu herkömmlichen REST-APIs. OpenDataSoft hat diese Norm für einfache Vorgänge (Suche nach Datensätzen und Einträgen) implementiert; für komplexere Vorgänge (wie Analysen, Aggregationen, geografische Berechnungen,...) müssen unsere ODS Search APIs (v1 und v2) verwendet werden.

  • WFS und CSW: Standards, die sich auf geografische Daten konzentrieren. Sie sind daher besonders wichtig, falls Sie die Plattform mit weiterer GIS-Software koppeln möchten.