Opencaching-API

Die Opencaching-API (kurz: OKAPI) ist eine moderne Programmierschnittstelle, mit der Cache-, und Log- und Benutzerdaten von Opencaching-Seiten abgerufen werden können. Außerdem ist das Hochladen von Logs möglich. Dadurch lassen sich z.B. Smartphone-Apps mit Field-Logging-Funktion anbieten. Auch das Replizieren einer kompletten Opencaching-Datenbank ist möglich.

Weitere Funktionen sind das Beobachten und Ignorieren vom Caches; dabei wird auf die entsprechenden Listen im Benutzerprofil zugegriffe.

Die OKAPI ist inzwischen bei den Opencaching-Länderseiten in Polen, den USA, Großbritannien und den Niederlanden verfügbar. Eine Bereitstellung auf Opencaching.de ist in Arbeit. Alternativ kann hier auch die weniger leistungsfähige XML-Schnittstelle genutzt werden.

Funktionsweise

Die OKAPI stellt verschiedene Webservices zur Verfügung, die Daten wahlweise im JSON- oder XML-Format liefern. Außerdem ist der Download von Cachedaten im GPX-Format möglich. Eine Beschreibung aller angebotenen Funktionen gibt es auf opencaching.pl/okapi.

Entwicklung

Die OKAPI wurde vom dem polnischen Geocacher Wojciech Rygielski (Wrygiel) entwickelt, der auch für die Weiterführung des Projekts verantwortlich ist. Die Entwicklung wird zentral auf Google Code koordiniert; von dort werden Code-Updates auf die einzelnen Länderseiten verteilt.

Einschränkungen

Gegenüber der üblichen Opencaching.de-Funktionalität hat die OKAPI einige Einschränkungen:

• Eventcaches können nicht geloggt werden (in Arbeit)
• es können keine Logbilder hochgeladen werden
• Attribute sind bislang nur eingeschränkt nutzbar, weil es noch keine eindeutigen Attribut-Kennzeichnungen gibt. (in Arbeit)
• Zeitaufwand und Wegstrecke eines Caches sind nicht abfragbar (in Arbeit)

Außerdem sind gespeicherte Suchen aus dem Benutzerprofil nicht nutzbar. Dies ist technisch schwer zu realisieren und wird vermutlich nicht eingebaut. OKAPI-Anwendungen können dieses Feature mittels OKAPI-Suchfunktionen nachbilden.

Anpassung bestehender OKAPI-Clients an Opencaching.de

Grundsätzlich sind alle bestehenden OKAPI-Anwendungen auch mit Opencaching.de funktionsfähig. Im Zuge der OKAPI-Anpassung an Opencaching.de musste allerdings die Behandlung von Logtexten beim Hochladen von Logs (submit) geändert werden: Während sie früher je nach Installation teils als reiner Text (plain text) und teils als HTML verarbeitet wurden, sollte das Textformat nun explizit mit dem neuen Parameter comment_format angegeben werden. Ohne Angabe von comment_format wird der Text immer als HTML behandelt.

Clients, die sich nach der früheren OKAPI-Dokumentation bzw. der OKAPI-Installation auf Opencaching.nl gerichtet haben und plain text senden, sollten daher angepasst werden und zusätzlich comment_format=plaintext angeben. Andernfalls könnten Logtexte verstümmelt werden, die spezielle HTML-Zeichen (<, & etc.) enthalten.

→ weitere Informationen zum Log-Format