DE:OpenRailwayMap/API
Nutzungsbedingungen
Die OpenRailwayMap ist ein nicht-kommerzielles Projekt, das durch Spenden finanziert und durch den ehrenamtlichen Einsatz der Mitglieder umgesetzt wird. Unsere Infrastruktur bietet nur eine begrenzte Kapazität, daher gelten bei der Nutzung der API und der Tiles die folgenden Bedingungen:
- Kleinere Anwendungen mit unregelmäßigen oder relativ wenigen Abfragen dürfen die Tiles und die API frei und kostenlos nutzen.
- Wir möchten unsere Spendengelder nicht dazu verwenden, Dienste für gewerbliche Nutzer anzubieten. Wenn du die Tiles oder die API in einem gewinnorientierten Umfeld verwendest, solltest du deinen eigenen Server installieren.
- Anwendungen, die die Tiles oder die API nutzen, müssen öffentlich zugänglich sein (gebührenfrei und ohne Registrierungspflicht). Dies gilt nicht für in Entwicklung befindliche Projekte, die nur wenige Tile-/API-Anfragen verursachen.
- Gewerbliche Projekte und solche, die nicht öffentlich zugänglich sind, können ohne vorherige Ankündigung gesperrt werden.
- Nicht-gewerbliche Projekte, die erheblich Last erzeugen, wird empfohlen, einen eigenen Cache zu betreiben.
- Anwendungen müssen einen eindeutigen HTTP-User-Agent senden. Beim Einbinden in einer Webseite muss der Browser einen gültigen Referer mitsenden.
- Fälsche keine Referer oder User-Agents.
- Wenn mit HTTP-Statuscode 429 geantwortet wird, sollte die Nutzung der Tiles/API eingestellt werden, um stärker und längere Sperren zu vermeiden.
- Werden regelmäßig und in größerem Stil API-Abfragen gesendet oder Tiles angefragt, dann werden die entsprechenden Nutzer blockiert und - falls identifizierbar - kontaktiert.
- Die Beantwortung von API-Anfragen sollte in der Regel nicht länger als 3 Sekunden dauern. Trotzdem sollten Anwendungen so geschrieben werden, dass Anfragen nach etwa 5 Sekunden abgebrochen werden. Schlagen mehrere Anfragen kurz hintereinander fehl, dann sollte eine Anwendung davon ausgehen, dass die API momentan nicht erreichbar ist und die Abfragerate senken.
- Wenn die API oder die Tiles durch Anwendungen genutzt wird, sollten nur dann Daten abgefragt werden, wenn sie durch den Benutzer aktiv angefordert wurden. Massenhafte Anfragen sind nicht gestattet.
- Dieses Projekt wird von Freiwilligen in deren Freizeit betrieben. Es gibt keinen Anspruch auf Support und Verfügbarkeit. Falls du einen garantiert zuverlässigen Service benötigst, solltest du eine eigene Instanz installieren.
Die Daten der OpenStreetMap-Datenbank, aus der die Daten der OpenRailwayMap stammen, stehen unter der Lizenz Open Data Commons Open Database License (ODbL). Die Tiles der OpenRailwayMap stehen unter der Creative-Commons-Lizenz Namensnennung - Weitergabe unter gleichen Bedingungen 2.0 (CC-BY-SA 2.0).
Beim Einbinden der OpenRailwayMap-Karte oder einer anderen Nutzung der Tiles ist also folgender Hinweis notwendig:
Daten <a href="https://www.openstreetmap.org/copyright">© OpenStreetMap-Mitwirkende</a>, Grafik: <a href="http://creativecommons.org/licenses/by-sa/2.0/">CC-BY-SA 2.0</a> <a href="http://www.openrailwaymap.org/">OpenRailwayMap</a>
Wird als Hintergrund zusätzlich eine herkömmliche OpenStreetMap-Karte verwendet, was unter anderem beim Einbinden der OpenRailwayMap-Webseite stattfindet, ist folgender Hinweis notwendig:
Daten <a href="https://www.openstreetmap.org/copyright">© OpenStreetMap-Mitwirkende</a>, Grafik: <a href="http://creativecommons.org/licenses/by-sa/2.0/">CC-BY-SA 2.0</a> <a href="http://www.openrailwaymap.org/">OpenRailwayMap</a> und OpenStreetMap
Werden dagegen Daten von der API abgefragt, ist folgender Hinweis in die Anwendung einzubauen:
Daten <a href="https://www.openstreetmap.org/copyright">© OpenStreetMap-Mitwirkende</a>, Anbieter: <a href="http://www.openrailwaymap.org/">OpenRailwayMap</a>
Ein Hinweis ist ungültig, wenn der Text die gleiche Farbe wie der Hintergrund hat, die Schrift unleserlich klein ist, der Hinweistext teilweise oder vollständig verdeckt ist oder die Links fehlen.
Tiles
The map tiles follow the standard Web Mercator tile format - also known as Spherical Mercator, OpenStreetMap or Google tiles. They are usually supported natively by any map library that you are using, but read on if you want to know more details.
Die Tiles haben eine Größe 512 x 512 Pixeln und liegen im PNG-Format vor. Effektiv beträgt die Auflösung 256 x 256 Pixel, die doppelte Auflösung ergibt sich aus der "Retina"-Qualität. Als Projektion wird Spherical Mercator verwendet, das unter den EPSG-Codes EPSG:3857, EPSG:900913 und EPSG:3785 bekannt ist. Sie sind unter folgender URL abrufbar:
http://${s}.tiles.openrailwaymap.org/${style}/${z}/${x}/${y}.png
In modernen Browsern ist die Zahl der gleichzeitigen Bildanfragen an eine Domain standardmäßig begrenzt. Um diese Begrenzung zu umgehen und das Laden der Tiles zu beschleunigen, können Anfragen an verschiedene Subdomains gestellt werden, die auf den gleichen Server verweisen. Durch das Ersetzen des Platzhalters ${s} durch a, b oder c werden künstlich unterschiedliche Subdomains erzeugt. Dieses Domainpräfix kann aber auch weggelassen werden, falls er nicht benötigt wird.
Der Platzhalter ${style} wird durch den gewünschten Kartenstil ersetzt. Momentan existieren folgende Stile:
| Wert | Erläuterung |
|---|---|
| standard | Standard-Eisenbahnlayer mit der Darstellung der Basisinfrastruktur wie etwa Gleise, Betriebsstellen, Streckennummern, Weichen, etc |
| signals | Darstellung von Signalen und Zugsicherungssystemen |
| maxspeed | Darstellung von Streckenhöchstgeschwindigkeiten und Geschwindigkeitssignalen |
Einbindung in OpenLayers 3
var openrailwaymap = new ol.layer.Tile({
title: 'OpenRailwayMap',
visible: true,
source : new ol.source.XYZ({
attributions : [
ol.source.OSM.ATTRIBUTION,
new ol.Attribution({
html : 'Grafik: <a href="http://creativecommons.org/licenses/by-sa/2.0/">CC-BY-SA 2.0</a> <a href="http://www.openrailwaymap.org/">OpenRailwayMap</a> und OpenStreetMap'
})
],
url : 'http://{a-c}.tiles.openrailwaymap.org/standard/{z}/{x}/{y}.png',
crossOrigin: null, //make it work inside canvas
tilePixelRatio: 2, //server returns 512px img for 256 tiles
maxZoom: 19, // XYZ's default is 18
opaque: true
})
})
map.addLayer(openrailwaymap);
Einbindung in Leaflet
var openrailwaymap = new L.TileLayer('http://{s}.tiles.openrailwaymap.org/standard/{z}/{x}/{y}.png',
{
attribution: "<a href="https://www.openstreetmap.org/copyright">© OpenStreetMap-Mitwirkende</a>, Grafik: <a href="http://creativecommons.org/licenses/by-sa/2.0/">CC-BY-SA 2.0</a> <a href="http://www.openrailwaymap.org/">OpenRailwayMap</a> und OpenStreetMap",
minZoom: 2,
maxZoom: 19,
tileSize: 256
}).addTo(map);
Einbindung in OsmAnd
Die Kacheln der OpenRailwayMap können mit wenigen Schritten auch in die beliebte Android- und iOS-App OsmAnd eingebunden werden.
Die folgenden Schritte beziehen sich auf die Android-App. iOS-Nutzer beachten bitte die Hinweise von Krist van Besien in der OsmAnd-Google-Group.
Um die folgenden Schritte vollziehen zu können, muss das Plugin "Online-Karten" aktiviert sein. Die Liste der Plugins ist über das Viereck-Symbol, im Hauptmenü links unten, abrufbar (ggf. nach unten scrollen und in der Plugin-Box "Alles zeigen" anwählen).
- In der Kartenansicht das runde Ebenen-Symbol (links oben) anwählen.
- Im nun erscheinenden Menü "Karte konfigurieren" "Overlay-Karte..." oder "Underlay-Karte..." anwählen.
- Nun "Weitere installieren..." wählen, nach unten scrollen und aus der Liste die gewünschten OpenRailwayMap-Layer (OpenRailwayMap, OpenRailwayMap maxspeed, OpenRailwayMap signalling) auswählen.
Damit stehen die Karten im Overlay- bzw. Underlay-Menü zur Verfügung.
Tipp: Standardmäßig können die Overlay-Karten blass wirken. Die Kartentransparenz kann auf zwei Wegen angepasst werdenː
- Über einen unscheinbaren blauen Schieberegler im unteren mittleren Bereich der Kartenansicht.
- Über die Einstellungen des Online-Karten-Pluginsː Viereck-Symbol links unten → "Online-Karten" aus der Plugin-Liste auswählen → "Einstellungen" → "Overlay-Transparenz" bzw. "Kartentransparenz".
Tipp: Die OpenRailwayMap-Karten können auch als Grundkarte verwendet werden (Ebenen-Symbol => "Kartenquelle"). Unter einem (OpenRailwayMap-)Overlay kann ein weiterer OpenRailwayMap-Layer als Underlay platziert werden. Grundsätzlich können so alle drei OpenRailwayMap-Karten gleichzeitig verwendet werden.
OsmAnd speichert heruntergeladene Kartenelemente auf dem Gerät. Einmal heruntergeladen, stehen diese auch offline zur Verfügung. Um sie zu aktualsieren, müssen sie im entsprechenden Unterverzeichnis von tiles im Osmand-Ordner gelöscht und neu heruntergeladen werden.
Eine reine Offline-Nutzung der OpenRailwayMap in OsmAnd ist derzeit noch nicht möglich. Dem Projekt stehen momentan nicht die Ressourcen zur Verfügung, um fertige Offlinedaten zum Download anzubieten. Es besteht zwar die Möglichkeit, auf dem eigenen Rechner selbst die Offlinekarten zu generieren, doch dafür fehlt noch ein entsprechender Kartenstil für OsmAnd. Informationen zum aktuellen Stand finden sich im Github-Repository der OpenRailwayMap.
Einbindung in QGIS
Die Tiles der OpenRailwayMap können auch in QGIS eingebunden werden. Dazu ist das Tile Map Scale Levels Plugin und die folgende XML-Konfiguration erforderlich. Der Platzhalter ${style} wird durch den gewünschten Kartenstil ersetzt. In der Tabelle oben sind die möglichen Werte aufgeführt.
<GDAL_WMS>
<Service name="TMS">
<ServerUrl>http://tiles.openrailwaymap.org/${style}/${z}/${x}/${y}.png</ServerUrl>
</Service>
<DataWindow>
<UpperLeftX>-20037508.34</UpperLeftX>
<UpperLeftY>20037508.34</UpperLeftY>
<LowerRightX>20037508.34</LowerRightX>
<LowerRightY>-20037508.34</LowerRightY>
<TileLevel>19</TileLevel>
<TileCountX>1</TileCountX>
<TileCountY>1</TileCountY>
<YOrigin>top</YOrigin>
</DataWindow>
<Projection>EPSG:3857</Projection>
<BlockSizeX>512</BlockSizeX>
<BlockSizeY>512</BlockSizeY>
<BandsCount>4</BandsCount>
<Cache>
<Path>/tmp/cache_osm_rail</Path>
</Cache>
</GDAL_WMS>
API
Die OpenRailwayMap stellt eine API mit folgender Funktionalität bereit:
- Betriebsstellensuche anhand von Namen und Betriebsstellenkürzel
- Kilometrierung in Bezug auf die Streckennummer
Die Dokumentation ist auf GitHub verfügbar.