Freifunk Fulda/Freifunk API

Aus Magrathea Laboratories e.V.
Wechseln zu: Navigation, Suche

Die übergreifende Community freifunk.net bietet ein API, um die Informationen der lokalen Communities auf einer gemeinsamen Plattform darstellen zu können. Um unsere Daten auf dieser Plattform bereitzustellen, sind die folgenden Schritte nötig.

Überblick

Die API wurde in Anlehnung an die Hackerspace API entwickelt und erlaubt den lokalen Communities, ihre Informationen selbst zu pflegen und - z.B. auf der eigenen Webseite - bereitzustellen. Das Format für den Datenaustausch ist JSON.

API Datei erzeugen

Der API-Generator auf freifunk.net erlaubt die Generierung einer initialen JSON-Datei. Das Formular vollständig ausfüllen, auf OK - Generate the full API file klicken und das Resultat herunterladen.

API Datei verfügbar machen

Die API Datei muss über unsere Webseite im Internet verfügbar gemacht werden. Zur Zeit ist das unter https://fulda.freifunk.net/FreifunkFulda-api.json

In das API Directory eintragen

Der Link zur API Datei muss jetzt in das API-Directory eingetragen werden. Dieses wird bei Github gepflegt. Die Eintragung kann per Pull-Request erfolgen oder über das Kontaktformular auf freifunk.net (Betreff "Frage zur API") angestoßen werden.

Automatisches Aktualisieren der Informationen

Die Aktualisierung der Anzahl aktiver Knoten in Fulda übernimmt ein kleines PHP-Skript.

Installation und Konfiguration

Zur Zeit läuft das Skript (sowie die Freifunk Fulda Webseite) auf einem von Majors Servern.

  • Klonen
cd /opt
git clone https://github.com/freifunk-fulda/ff-api-updater.git
  • Konfigurationsdatei anlegen
cd ff-api-updater
cp config.example.php config.php
  • Skript konfigurieren (/opt/ff-api-updater/config.php)
$NODELIST = 'https://meshviewer.fulda.freifunk.net/data/nodes.json';

  • Cronjob
cp /opt/ff-api-updater/ff-api-update.cron /etc/cron.d/ff-api-updater
  • DONE

Statische Inhalte der API Datei anpassen

Wie bei #API Datei erzeugen nutzt man den API-Generator auf freifunk.net, allerdings mit dem Unterschied, dass man vorher das API file von https://fulda.freifunk.net/FreifunkFulda-api.json kopiert und dann auf JSON to form klickt. Danach aktualisiert man alle Daten, die man ändern möchte (node-Daten werden dank des Scripts automatisch aktualisiert) und klickt dann auf OK - Generate the full API file klicken und das Resultat herunterladen. Danach fährt man mit #API Datei verfügbar machen fort.