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: "You don't need analogies to understand APIs".

Opendatasoft bietet Zugriff auf 6 APIs:

  • ODS Explore API V2: die wichtigsten Explore-APIs. Sie werden zur Erkundung von Katalogen und Datensätzen mit einer benutzerdefinierten SQL-ähnlichen Abfragesprache - ODSQL - verwendet.

  • Triple Pattern Fragments API: ODS API für Triple-Pattern-Abfrage der Datensätze auf Opendatasoft-Portalen

  • OData, WFS, znd CSW: 3 Standardprotokolle, die von Opendatasoft unterstützt und bereitgestellt werden

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 weiterverwendet, um neue Anwendungen zu entwickeln. So sind 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 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.

ODS Explore API

Die ODS Explore API wird in den Widgets von Opendatasoft verwendet. Für die Entwicklung einer Anwendung empfehlen wir die Verwendung von V2 dieser API.

Derzeit gibt es 2 Versionen der ODS Explore API: V2 und V1, die mittlerweile veraltet ist. Im Folgenden werden die wichtigsten Unterschiede zwischen den 2 Versionen aufgeführt.

  • Die wichtigsten Änderungen in der V2:

    • Eine reichhaltigere Abfragesprache (ODSQL) mit neuen Funktionen und arithmetischen Ausdrücken

    • Spezielle Filter (wie Geofilter und Facettenfilter) sind jetzt direkt in ODSQL integriert (im Parameter where).

    • Wir haben die Analyse-API eingestellt, da alle Vorgänge jetzt an allen Endpunkten verfügbar sind. Wenn Sie eine Analyse (mit Ausdrücken oder Funktionen) durchführen möchten, können Sie dies entweder auf Katalog- oder auf dem Datensatz-Endpunkt tun. Wenn Sie eine Analyse für Datensätzen-Gruppen durchführen möchten, können Sie diese einfach mit einem REST-Parameter "group_by" gruppieren.

Triple Pattern Fragments

Die Triple Pattern Fragments (TPF) API ermöglicht die Abfrage von Datensätzen im RDF-Format (Resource Description Framework).

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 Explore API bleiben, da sie den umfassendsten Zugang zu den Daten bietet.

  • OData ist ein Standard für REST-APIs, der eine gemeinsame, API-übergreifende Sprache zur Durchführung von Anfragen bietet. 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,...) sollten Sie unsere Explore API V2 verwenden.

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