Erste Schritte mit der API

Von Jens Dobberthin
14.04.2021 | 20 Minuten Lesezeit
Tweet

Dieser Blog-Beitrag ist der Auftakt zu einer Reihe von Beiträgen, in denen wir zeigen, wie ihr die API des Datenportals verwenden könnt, um eure eigenen datengesteuerten Anwendungen zu erstellen. Als Starter werden wir eine interaktive Karte in einem Jupyter-Notizbuch servieren.

Unser Datenportal ist zwar ein großer Fortschritt in Bezug auf den Zugriff auf unsere digitalen Inhalte. Falls ihr aber bereits einige Programmierkentnisse besitzt, dann könnt ihr mit unserer API noch viel mehr tun.

Bevor wir jedoch mit unserer Fallstudie beginnen, haben wir hier einige wichtige Fakten aufgeführt, die ihr im Voraus kennen solltet.

Was ist eine API?

Einfach ausgedrückt ist eine API (Application Programming Interface) eine Schnittstelle, mit der du kommunizieren kannst. Normalerweise möchten wir unseren Kommunikationspartner anweisen, etwas zu tun. In unserem Fall ist dieser Partner das Datenportal und wir können bestimmte Anweisungen (auch Abfragen genannt) an das Datenportal senden, um Daten abzurufen.

Welche Art von Abfragen kann ich verwenden?

Höchstwahrscheinlich möchtet ihr folgende Abfragen ausführen:

eine Volltextsuche über den gesamten Inhalt des Portals durchführen, z.B. in der Art gib mir alle Dokumente zurück, die das Wort Pinguin in ihren Titel- oder Beschreibungsfeldern enthalten;
die Suchergebnisse eingrenzen, indem du Filter anwendest, wie z.B. gib mir alle Dokumente zurück, die als song markiert sind;
eine facettierte Suche durchführen, also herausfinden, wie viele Dokumente dieselben Eigenschaften haben.

Die gute Nachricht ist: Du kannst das alles mit unserer API tun. Darüber hinaus kannst du auch alle Mediendateien und ihre jeweiligen Metadaten herunterladen.

Wie kann ich die API verwenden?

Zum Zeitpunkt der Erstellung dieses Beitrags bieten wir keine umfassende Dokumentation unserer API an. Als Ausgangspunkt für Interessierte werden wir in unregelmäßigen Abständen Blog-Beiträge zu diesem Thema veröffentlichen.

Welche Fähigkeiten benötige ich, um die API zu verwenden?

Du solltest über grundlegende Programmierkenntnisse in mindestens einer Programmiersprache verfügen. In unseren Beispielen und Fallstudien verwenden wir Python und gelegentlich R . Wir verwenden auch Jupyter-Notizbücher , damit du unseren Beispielen leicht folgen kannst. Wenn du denkst, dass du noch nicht über die richtigen Programmierkenntnisse verfügst, dann findest du am Ende dieses Artikels weiterführende Links und Information, wie du dir die nötigen Kenntnisse aneigenen kannst.

Was sind unsere Nutzungsbedingungen?

Bitte beachte, dass wir frühzeitig Zugriff auf unsere API gewähren und unsere API sich in den nächsten Wochen und Monaten ändern kann. Beachte auch, dass wir den Zugriff auf die API derzeit frei und ohne Einschränkungen gewähren. Bei unsachgemäßer Verwendung können wir dies jedoch jederzeit ändern.

Nachdem dies alles klar ist, beginnen wir mit unserer Beispielanwendung.

Fallstudie: Erstellen einer interaktiven Karte

Vor ein paar Wochen haben wir eine feine Sammlung biotischer, abiotischer und anthropogener Unterwassergeräusche für den Musik-Hackathon Your Ocean Sound veröffentlicht. Wir werden diese Sammlung als zugrunde liegenden Datensatz für die erste Fallstudie verwenden.

In diesem Beispiel erstellen wir eine interaktive Karte, damit wir visualisieren können, wo die Tonaufnahmen gemacht wurden. Hier ist ein kurzer Überblick darüber, was wir tun möchten:

den Ort jeder Aufnahme auf der Karte anzeigen;
ein Popup öffnen, um Titel, Beschreibung, Autor und Lizenz der Tonaufnahme anzuzeigen;
einen Audio-Player zum Abspielen der Audiodateien einbinden.

Hier ist eine Vorschau auf das, was wir bauen wollen:

Ein kurzer Überblick über unsere datengesteuerte Beispielanwendung

Die vollständige Anwendung ist als Jupyter-Notizbuch hier verfügbar. In Jupyter Notebooks können wir Code, Visualisierungen und narrativen Text mischen. Daher passt es perfekt für uns, um die Verwendung unserer API zu demonstrieren. Momentan stellen wir unsere Notebooks nur in englischer Sprache zur Verfügung. Wenn du sie also in einer anderen Sprache lesen möchtest, verwende bitte die Übersetzungsfunktion deines bevorzugten Browsers.

Öffne das Notebook in einem neuen Tab.

Fazit

Nachdem du unsere Fallstudie bearbeitet hast, kannst du

auf die API zugreifen;
einfache Abfragen formulieren;
einfache Filter anwenden, um deine Suchergebnisse einzugrenzen.

Du hast gesehen, dass du ohne großen Aufwand deine eigenen interaktiven Anwendungen erstellen kannst. Nutze einfach unsere API. In den nächsten Wochen werden wir weitere Notebooks bereitstellen. Am besten du verfolgst regelmäßig unseren Blog, damit du auf dem Laufenden bleibst.

Bei Fragen oder Anregungen zu unserer API schreibe bitte an portal@mfn.berlin . Wir sind gespannt, was für Anwendungen ihr erstellt.