Freifunk API: Unterschied zwischen den Versionen
Keine Bearbeitungszusammenfassung |
|||
| (16 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 9: | Zeile 9: | ||
=== Vorbemerkung === |
=== Vorbemerkung === |
||
Die Freifunk API dient dem gemeinsamen Datenaustausch zwischen allen Freifunk Communities. Darauf aufbauend werden gemeinsame Dienste wie Community Übersicht und Karten bedient. |
Die Freifunk API dient dem gemeinsamen Datenaustausch zwischen allen Freifunk Communities. Darauf aufbauend werden gemeinsame Dienste wie Community Übersicht und Karten bedient. Derzeit gibt es zwei API Bestandteile: |
||
* Freifunk Community API |
|||
| ⚫ | |||
| ⚫ | |||
** Anzeige: http://freifunk.net/wie-mache-ich-mit/community-finden/ (http://api-viewer.freifunk.net) |
|||
* Freifunk Nodelist API |
|||
** Generator: via Export aus [[Geronimo]] Nodes API |
|||
** Quellen und Verwaltung: https://gist.github.com/StilgarBF/c21826994b775787f739 |
|||
** Anzeige: http://www.freifunk-karte.de |
|||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
https://api.opennet-initiative.de/freifunk/ |
|||
| ⚫ | |||
* Freifunk Community API: https://api.opennet-initiative.de/freifunk/api.freifunk.net-<opennet-region>.json |
|||
| ⚫ | |||
* |
* Freifunk Nodelist API: https://api.opennet-initiative.de/freifunk/dynamic/nodelist.json |
||
Die Nodelist API URL ist als "nodeMaps" Eigenschaft in der Community API Datei für Rostock eingebunden und liefert gleichzeitig alle anderen Regionen aus. |
|||
=== Betrieb === |
=== Betrieb === |
||
'''Community API''' |
|||
Derzeit wird die Datei nur manuell gepflegt. |
|||
Die Community API Dateien von Opennet werden über einen Konverter von [[Geronimo]] ''geronimo_freifunkcommunity.sh'' basierend auf einem JSON Template und einer statischen Konfigurationsdatei erzeugt. Dort sind die Opennet Regionen hinterlegt. Die Erstellung erfolgt nach Bedarf, z.B. wenn eine neue Opennet Region hinzugefügt werden soll oder falls sich die Freifunk API geändert hat. Kontrolle ist über http://api-viewer.freifunk.net und den API Generator unter |
|||
http://freifunk.net/api-generator/ möglich. |
|||
'''Nodelist API''' |
|||
Die Nodelist API Dateien von Opennet werden über einen Konverter von [[Geronimo]] ''geronimo_freifunknodeslist.sh'' erzeugt. Ein Cronjon läuft alle 10 Minuten. Kontrolle ist über http://www.freifunk-karte.de/debug.php möglich. Probleme können auch über https://github.com/ffansbach/de-map/issues gemeldet werden. |
|||
=== TODO === |
=== TODO === |
||
* Auftrennung der Knotenliste in Opennet Regionen |
|||
* für jede Stadt ein API File |
|||
* automatische Aktualisierung |
|||
[[Category:Software]] |
[[Category:Software]] |
||
Aktuelle Version vom 2. Februar 2021, 16:32 Uhr
| Team |
 Freifunk API |
| Treffen: nur bei Bedarf |
| Freifunk API |
| Mitglieder: Lars, Martin G., Mahias M. |
| Kontakt: admin@opennet-initiative.de |
Vorbemerkung
Die Freifunk API dient dem gemeinsamen Datenaustausch zwischen allen Freifunk Communities. Darauf aufbauend werden gemeinsame Dienste wie Community Übersicht und Karten bedient. Derzeit gibt es zwei API Bestandteile:
- Freifunk Community API
- Generator: http://freifunk.net/api-generator/
- Quellen und Verwaltung: https://github.com/freifunk/api.freifunk.net
- Anzeige: http://freifunk.net/wie-mache-ich-mit/community-finden/ (http://api-viewer.freifunk.net)
- Freifunk Nodelist API
- Generator: via Export aus Geronimo Nodes API
- Quellen und Verwaltung: https://gist.github.com/StilgarBF/c21826994b775787f739
- Anzeige: http://www.freifunk-karte.de
Einrichtung
Auf Server/jun stellen wir unsere JSON Dateien im API File Format bereit:
https://api.opennet-initiative.de/freifunk/
- Freifunk Community API: https://api.opennet-initiative.de/freifunk/api.freifunk.net-<opennet-region>.json
- Freifunk Nodelist API: https://api.opennet-initiative.de/freifunk/dynamic/nodelist.json
Die Nodelist API URL ist als "nodeMaps" Eigenschaft in der Community API Datei für Rostock eingebunden und liefert gleichzeitig alle anderen Regionen aus.
Betrieb
Community API
Die Community API Dateien von Opennet werden über einen Konverter von Geronimo geronimo_freifunkcommunity.sh basierend auf einem JSON Template und einer statischen Konfigurationsdatei erzeugt. Dort sind die Opennet Regionen hinterlegt. Die Erstellung erfolgt nach Bedarf, z.B. wenn eine neue Opennet Region hinzugefügt werden soll oder falls sich die Freifunk API geändert hat. Kontrolle ist über http://api-viewer.freifunk.net und den API Generator unter http://freifunk.net/api-generator/ möglich.
Nodelist API
Die Nodelist API Dateien von Opennet werden über einen Konverter von Geronimo geronimo_freifunknodeslist.sh erzeugt. Ein Cronjon läuft alle 10 Minuten. Kontrolle ist über http://www.freifunk-karte.de/debug.php möglich. Probleme können auch über https://github.com/ffansbach/de-map/issues gemeldet werden.
TODO
- Auftrennung der Knotenliste in Opennet Regionen