Opencaching-API: Unterschied zwischen den Versionen

Zur Navigation springen Zur Suche springen
1.240 Bytes hinzugefügt ,  9. September 2015
Link zum Forum aktualisiert
(Link zum Forum aktualisiert)
 
(18 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
Weitere Funktionen sind das [[Caches beobachten|Beobachten]] und [[Caches ignorieren|Ignorieren]] vom Caches; dabei wird auf die entsprechenden Listen im Benutzerprofil zugegriffen.
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 bei den [[Opencaching|Opencaching-Länderseiten]] in Deutschland/Italien/Spanien, Polen, den USA, Großbritannien und den Niederlanden verfügbar. Auf Opencaching.de kann alternativ auch die weniger leistungsfähige [[XML-Schnittstelle]] genutzt werden.
 
Es gibt bereits einige [[OKAPI-Clients]] für Opencaching.de.


== Funktionsweise ==
== Funktionsweise ==
Die OKAPI stellt verschiedene Webservices zur Verfügung, die Daten wahlweise im [http://www.json.org/ JSON]- oder XML-Format liefern. Außerdem ist der Download von Cachedaten im [[GPX-Datei|GPX-Format]] möglich. Eine Beschreibung aller angebotenen Funktionen gibt es auf [http://www.opencaching.pl/okapi/ opencaching.pl/okapi].
Die OKAPI stellt verschiedene Webservices zur Verfügung, die Daten wahlweise im [http://www.json.org/ JSON]- oder XML-Format liefern. Außerdem ist der Download von Cachedaten im [[GPX-Datei|GPX-Format]] möglich. Eine Beschreibung aller angebotenen Funktionen gibt es auf '''[http://www.opencaching.de/okapi/ opencaching.de/okapi]'''.
 
== Zugriff auf das Benutzerkonto ==
Wenn eine OKAPI-Anwendung deine Funde oder Nichtfunde anzeigen, auf deine [[Caches beobachten|Beobachtungs-]] oder [[Caches ignorieren|Ignorierliste]] zugreifen soll oder Caches [[Das Onlinelog|loggen]] soll, musst du ihr Zugriff auf dein [[Benutzerprofil|Benutzerkonto]] gewähren. Dies geht halbautomatisch innerhalb der Anwendung: Du wirst bei Bedarf gefragt, ob du den Zugriff gewähren möchtest.
 
Mit dem Menüpunkt [http://www.opencaching.de/okapi/apps/ API-Anwendung] unter „Mein Profil“ kannst du sehen, welchen Anwendungen du Zugriff gegeben hast, und kannst dies jeweils widerrufen.


== Entwicklung ==
== Entwicklung ==
Die OKAPI wurde vom dem polnischen Geocacher Wojciech Rygielski ([http://forum.geocaching-network.com/index.php?action=profile;u=410 Wrygiel]) entwickelt, der auch für die Weiterführung des Projekts verantwortlich ist. Die Entwicklung wird zentral auf [http://code.google.com/p/opencaching-api/ Google Code] koordiniert; von dort werden Code-Updates auf die einzelnen Länderseiten verteilt.
Die OKAPI wurde vom dem polnischen Geocacher Wojciech Rygielski ([http://forum.opencaching.de/index.php?action=profile;u=410 Wrygiel]) entwickelt, der auch für die Weiterführung des Projekts verantwortlich ist. Die Entwicklung wird zentral auf [http://code.google.com/p/opencaching-api/ Google Code] koordiniert; von dort werden Code-Updates auf die einzelnen Länderseiten verteilt.
 
Die OKAPI-Entwicklung ist offen für jeden, der etwas beitragen möchte. Wenn bestimmte Features für eine Anwendung fehlen kann man also versuchen, sie selbst einzubauen.


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


* Attribute werden bislang nur als Textliste statt einzelne Felder mit wohldefinierten IDs mitgeliefert, auch in GPX-Dateien. ([http://code.google.com/p/opencaching-api/issues/detail?id=70 in Arbeit])
* es können keine Logbilder hochgeladen werden
* es können keine Logbilder hochgeladen werden
* es können keine Status(änderungen) geloggt werden
* gesperrte Caches können nicht abgerufen werden ([http://code.google.com/p/opencaching-api/issues/detail?id=123 Info])
* gesperrte Caches können nicht abgerufen werden ([http://code.google.com/p/opencaching-api/issues/detail?id=123 Info])
* gespeicherte Suchen aus dem Benutzerprofil sind nicht nutzbar
* gespeicherte Suchen aus dem Benutzerprofil sind nicht nutzbar
* GC- und NC-Wegpunkte von [[Mehrfachlisting]]s sind nicht abfragbar


== 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. Die Beachtung der folgenden Punkte kann aber hilfreich sein:
Grundsätzlich sind alle bestehenden OKAPI-Anwendungen auch mit Opencaching.de funktionsfähig. Die Beachtung der folgenden Punkte kann aber hilfreich sein:
=== Cachetypen ===
Die OKAPI dokumentiert bislang nur die Cachetypen "Traditional", "Multi", "Quiz", "Virtual" und "Event". Auf Opencaching.de gibt es fünf weitere Typen, die in der OKAPI (geocache.type) wie folgt heißen:
* Webcam
* Moving
* Math/Physics
* Drive-In
* Other
Der Typ Math/Physics wird wahrscheinlich nicht mehr lange verwendet und kann als "Quiz" dargestellt werden.
''Achtung:'' Suchabfragen nach diesen Cachetypen auf anderen OC-Seiten als Opencaching.de/.it/.es führen zu einer OKAPI-Fehlermeldung. Bei der Suche muss also die gewählte OC-Seite mit berücksichtigt werden.


=== Logtext-Format ===
=== Logtext-Format ===
Zeile 51: Zeile 70:
* die geschätzte Zeit und Wegstrecke für einen Cache können abgerufen werden, wenn im Listing vorhanden
* die geschätzte Zeit und Wegstrecke für einen Cache können abgerufen werden, wenn im Listing vorhanden
* das [[Vorschaubilder|Vorschaubild]] eines Caches ist abrufbar
* das [[Vorschaubilder|Vorschaubild]] eines Caches ist abrufbar
* die neue GPX-Option "images=descrefs:thumblinks" bettet verlinkte Thumbnail-Bilder in GPX-Daten ein
* GC-Codes von [[Mehrfachlisting]]s sind abfragbar
* Es wurden globale, mit eigenen IDs („A-Codes“) identifizierte Attribute eingeführt.
* [[Schutzgebiete]], in denen Geocaches sich wahrscheinlich befinden, sind abfragbar


Weitere Ergänzungen sind in Arbeit.
== Anmerkungen ==
<references>
<ref name="it_es">Opencaching.de schließt auch die italienische Seite Opencaching.it und die spanische Opencachingspain.es mit ein; alle laufen auf dem gleichen [[Technik|Server]].</ref>
</references>
[[Kategorie:Opencaching]]
[[Kategorie:Geocaching-Software]]
[[Kategorie:Geocaching-Software]]

Navigationsmenü