Kiezatlas 2 API

Erläuterungen zur Integration und Nutzung

Kurzvorstellung Kiezatlas
Struktur der Kiezatlas-Datensätze
Funktionsumfang der Schnittstelle
Ideen und Planung zur Entwicklung
Freischaltung zur Nutzung
Überblick zu technischen Anbindungen

Soziale Einrichtungen in Berlin

Kurzvorstellung

Im Kiezatlas sind aktuell ca. 8000 Einrichtungen mit sozialem Auftrag verzeichnet. Dieser dezentral gepflegte Datensatz umfasst zur Zeit neun Berliner Bezirke und repräsentiert weitestgehend nicht-kommerzielle Orte.

Im Zuge einiger Neu-Entwicklungen können unsere Datensätze nun in Web- oder Desktop-Anwendungen von Dritten durchsucht, referenziert und somit wiederverwendet werden.

Das ist die Idee hinter der neuen Kiezatlas-Schnittstelle, der sog. Kiezatlas 2 API (Dokumentation).

2. Kiezatlas Datensatz

Die Kiezatlas 2 API antwortet mit Einrichtungsdatensätzen als Ergebnis. Die Daten der API verstehen wir als öffentlich und Dritten können diese auf ihren Seiten entsprechend ihren eigenen Anforderungen visualisieren:

Name der Einrichtung
Geo Koordinate der Einrichtung (Längen, Breitengrad)
Name des Bezirks der Einrichtung
Anschrift der Einrichtung (Straße, Hnr., PLZ)
URI zur Identifizierung der Einrichtung
Link in den Kiezatlas-Stadtplan

Zur Veranschaulichung einmal zwei Beispiele.

2.1 Familienportal Integration

2.2 Zuweisungen von Angeboten

Hier einmal die Such-API und Wiederverwendung von Kiezatlas Einrichtungen in Aktion. Eingesetzt zur Zuweisung von Angebotsinfos zu Orten.

3. Funktionsumfang

Textbasierte Abfrage (Suche) sozialer Einrichtungen in Berlin nach "Name", "Beschreibung", "Stichworten" und "Sonstiges"

Mögliche und geplante Ausbaustufen

Bearbeitungsvermerk an eine Kiezatlas-Einrichtungen setzen
Suche nach sozialen Einrichtung anhand weiterer Kriterien

4. Ideen und Plan zur Weiterentwicklung

Freischaltung der API je Nutzer_in, Abklären der Nutzungsbedingungen
Suchfunktion nach Kiezatlas-Einrichtungen
(Ende Mai / Anfang Juni)
Einführung zum posten einer Bearbeitungsnotiz auf Ebene einzelner Einrichtungsdatensätze durch (Dritte) Nutzer_innen

5. API Freischaltung

Im folgenden leiten wir dich zur Freischaltung der API für deinen Nutzernamen und geben dir einen Überlick über die Rahmenbedingungen einer technischen Integration unserer Einrichtungsdatensätze in deine Anwendung.

5.1 Registrierung

Falls ihr für eure Website noch keinen Kiezatlas-Nutzeraccount angeleg habt, das geht unter http://kreise.kiezatlas.de/sign-up

Zur Anmeldung erforderlich sind eine gültige E-Mail Adresse sowie ein neuer Nutzername.

5.2 API aktivieren

Auf der Seite eures Kiezatlas-Nutzeraccounts könnt ihr diesen selbstständig für die Nutzung unserer API freischalten.

Für die erfolgreiche Freischaltung müsst ihr unsere Nutzungsbedingungen akzeptieren.

5.3 Technisches

Technisch gesehen müssen Anwendungen Dritter einen einfachen HTTP Client ihrerseits integrieren und dieser muss mindestens drei Funktionen realisieren:

Authentifizierung mittels sog. "HTTP Authentication"
Suchabfrage von Einrichtungsdatensätzen anhand von Texteingabe mittels eines einfachen GET-Requests
Darstellung der Ergebnisse Kiezatlas-Datensätze "im eigenen Gewand" jedoch mit einem "Powered by Kiezatlas" Hinweis

Dazu gibt es bereits zwei Kiezatlas 2 API Clients auf denen eure Entwickler technisch aufbauen können:
Python Client (Kiezatlas), PHP Client (Familienportal)