Opencaching-API: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
ausgebaut
(ausgebaut) |
|||
| Zeile 1: | Zeile 1: | ||
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 [[Log]]s möglich. Dadurch lassen sich z.B. [[Smartphone-Caching|Smartphone-Apps]] mit [[Fachjargon#Field Logging|Field-Logging]]-Funktion anbieten. Auch das Replizieren einer kompletten Opencaching-Datenbank ist möglich. | 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 [[Log]]s möglich. Dadurch lassen sich z.B. [[Smartphone-Caching|Smartphone-Apps]] mit [[Fachjargon#Field Logging|Field-Logging]]-Funktion anbieten. Auch das Replizieren einer kompletten Opencaching-Datenbank ist möglich. | ||
Weitere Funktionen sind das [[Caches beobachten|Beobachten]] und [[Caches ignorieren|Ignorieren]] vom Caches; dabei wird auf die entsprechenden Listen im Benutzerprofil | Weitere Funktionen sind das [[Caches beobachten|Beobachten]] und [[Caches ignorieren|Ignorieren]] vom Caches; dabei wird auf die entsprechenden Listen im Benutzerprofil zugegriffen. | ||
Die OKAPI ist inzwischen bei den [[Opencaching|Opencaching-Länderseiten]] in Polen, den USA, Großbritannien und den Niederlanden verfügbar. Eine Bereitstellung auf Opencaching.de<ref name="it_es"/> ist in Arbeit. Alternativ kann hier auch die weniger leistungsfähige [[XML-Schnittstelle]] genutzt werden. | Die OKAPI ist inzwischen bei den [[Opencaching|Opencaching-Länderseiten]] in Polen, den USA, Großbritannien und den Niederlanden verfügbar. Eine Bereitstellung auf Opencaching.de<ref name="it_es"/> ist in Arbeit. Alternativ kann hier auch die weniger leistungsfähige [[XML-Schnittstelle]] genutzt werden. | ||
| Zeile 17: | Zeile 17: | ||
* es können keine Logbilder hochgeladen werden | * es können keine Logbilder hochgeladen werden | ||
* Attribute sind bislang nur eingeschränkt nutzbar, weil es noch keine eindeutigen Attribut-Kennzeichnungen gibt. (in Arbeit) | * Attribute sind bislang nur eingeschränkt nutzbar, weil es noch keine eindeutigen Attribut-Kennzeichnungen gibt. (in Arbeit) | ||
* | * Attribute in GPX-Dateien werden noch nicht als Datenfelder mitgeliefert sondern nur als Textanhang. (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. | 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 == | == Anpassung bestehender OKAPI-Clients an Opencaching.de == | ||
Grundsätzlich sind alle bestehenden OKAPI-Anwendungen auch mit Opencaching.de funktionsfähig. | Grundsätzlich sind alle bestehenden OKAPI-Anwendungen auch mit Opencaching.de funktionsfähig. Die Beachtung der folgenden Punkte kann aber hilfreich sein: | ||
=== Logtext-Format === | |||
Im Zuge der OKAPI-Anpassung an Opencaching.de wurde die Behandlung von Logtexten beim Hochladen von Logs (''submit'') geändert. Früher war das Format undefiniert – es konnte "plain text" oder HTML sein, und die Weiterverarbeitung hing von der jeweiligen Opencaching-Seite ab. Nun gibt es einen neuen Parameter ''comment_format'', mit dem das Format ausdrücklich angegeben werden kann und sollte. | |||
Auf keinen Fall sollte "plain text" ''ohne'' Angabe von ''comment_format=plaintext'' hochgeladen werden - der Text könnte verstümmelt werden. | |||
Unabhängig hiervon ist zu beachten, dass die Software [http://www.opencaching.de/articles.php?page=htmltags unerlaubte HTML-Tags] aus hochgeladenen Logtexten entfernt. | Unabhängig hiervon ist zu beachten, dass die Software [http://www.opencaching.de/articles.php?page=htmltags unerlaubte HTML-Tags] aus hochgeladenen Logtexten entfernt. | ||
→ [http://code.google.com/p/opencaching-api/issues/detail?&id=124 weitere Informationen zum OKAPI-Log-Format] | → [http://code.google.com/p/opencaching-api/issues/detail?&id=124 weitere Informationen zum OKAPI-Log-Format] | ||
===Lizenz-Disclaimer=== | |||
Die OKAPI hängt standardmäßig einen Disclaimer an alle abgerufenen Cachebeschreibungen an, der den Datenlizenz-Anforderungen der jeweiligen Opencaching-Website entspricht. Über die neue Option [http://www.opencaching.de/okapi/services/caches/geocache.html#arg_attribution_append attribution_append=none] kann dies abgeschaltet werden. Stattdessen muss dann das Feld ''attribution_note'' angefordert und dessen Inhalt wiedergegeben bzw. mitgeliefert werden. | |||
== Anmerkungen == | == Anmerkungen == | ||