Live API uitleg

4Geocaching is naast een Groundspeak data licentie houder ook Live API partner van Groundspeak (geocaching.com). Zie voor meer informatie over de data licentie de Wie zijn wij pagina.

Wat is Live API?

Geocaching.com is bereikbaar middels de website www.geocaching.com. Daar kun je een account aanmaken, geocaches zoeken, loggen en nog veel meer. Dit is het gebruik die iedereen wel kent.
Maar Groundspeak heeft ook een andere manier van toegang verlenen tot zijn data en het kunnen loggen van geocaches bv. Dit gaat middels een zogenaamde API (Application Programming Interface). De API van Groundspeak bevat o.a. functies voor het kunnen zoeken naar geocaches, ophalen van geocaches gegevens zoals beschrijving en aantal Favorites, loggen van geocaches en zoeken van logs van een andere gebruiker.
Op deze manier kunnen applicaties van derden (zoals GAPP) en websites van derden (zoals 4Geocaching.eu) hun eigen functies aanbieden in hun applicaties/websites en voor specifieke functies de Live API gebruiken voor deze functies. Zo zie je bv op 4Geocaching.eu dat je geocaches kunt zoeken, bekijken en loggen. Het voordeel voor de gebruiker is dat ze nu meer mogelijkheden hebben dan alleen op geocaching.com website.

Hoe werkt Live API?

Je kunt je voorstellen dat niet iedereen de API zo maar mag gebruiken. Groundspeak wil wel weten wie de functies aanroept, maar ook welke applicatie/website. De eigenaar van de applicatie/website zal als eerste goedkeuring van Groundspeak moeten hebben om in zijn applicatie/website de Live API functies te mogen gebruiken. Hiervoor krijgt de maker van de applicatie/website een zogenaamde 'klant geheime sleutel'. Om vervolgens te bepalen welke gebruiker de Live API functies gebruikt, moet de gebruiker de applicatie autoriseren. De autorisatie werkt alsvolgt; De gebruiker geeft aan de applicatie/website aan dat die wil autoriseren. De applicatie/website vraagt aan Groundspeak goedkeuring en krijgt wat info. Vervolgens krijgt de gebruiker een webpagina te zien van geocaching.com. Je bent dus op de website van geocaching.com! Daar krijg je de vraag of de applicatie/website namens jou toegang mag hebben tot de Live API (als je niet ingelogd bent, krijg je eerst het inlogscherm van geocaching.com). Indien je bevestigt dat dit mag, zal de applicatie/website een toegangscode krijgen voor die gebruiker, de zogenaamde token. Deze token is gekoppeld aan zowel de applicatie/website als wel de gebruiker. Met elke aanroep van een Live API functie wordt de token meegegeven en hiermee kan Groundspeak bepalen met welke applicatie en welke gebruiker dit is aangeroepen.
De geldigheid van de token verloopt automatisch na 90 dagen. Je kunt bv na 80 dagen weer opnieuw de autorisatie uitvoeren om zo weer 90 dagen gebruik te kunnen maken van de nieuwe token.

Live API autorisatie op 4Geocaching.eu

Voor gebruikers van 4Geocaching.eu biedt het veel voordelen om de Live API autorisatie uit te voeren voor deze website. Want hiermee krijg je veel meer mogelijkheden zoals het kunnen bekijken, loggen en downloaden van geocaches. tevens zie je gelijk welke geocaches je al wel of niet hebt gevonden. tevens zijn sommige functies alleen voor Premium Members van geocaching.com, zoals het kunnen zoeken op Favorites. Om te bepalen of wij de bezoeker deze functie mogen aanbieden, moeten we weten of de bezoeker wel Premium Member is van geocaching.com.
4Geocaching.eu autoriseren voor de Live API kun je doen op de webpage 'Persoonlijk'->'Live API'.

Automatisch bijwerken van geocaches in GAPP en GSAK.

4Geocaching.eu heeft ook een soort API. Deze API bevat o.a. een functie om geocache codes met status (beschikbaar/gearchiveerd) op te vragen voor een van de drie ondersteunde landen. Voor zowel GAPP als GSAK zijn er mogelijkheden om hier gebruik van te maken. Belangrijk in beide applicaties is dat de Live API autorisatie in orde is.
Voor GAPP moet je voor zowel de Live API in de GAPP en op 4Geocaching.eu een geldige Live API autorisatie hebben.
Voor GSAK moet je in ieder geval voor 4Geocaching.eu website een geldige Live API autorisatie hebben.