OKAPI News

Somewhat delayed OKAPI news!

2015-09-23T20:54:00.001+02:00

It has been a while since the last post has been published here. OKAPI is as "alive" as it has ever been, but the blog is not being updated regularilly, sorry about that!

Here's what has changed in the last two years (!) - sinrce version 896 up to 1116 (7622a48):

OKAPI Project home page has moved from Google Code to GitHub. Since we're using Git now, our SVN-like revision numbers are no longer "real" revision numbers. However, for readability and backward compatibility, we're keeping the "legacy" version sequencing intact. The only difference is that we're now calling them "OKAPI version numbers" instead of "OKAPI revisions". Two new fields has been added to the services/apisrv/installation method: okapi_version_number and git_revision.
New fields in the geocache method: short_description and short_descriptions.
New save_personal_notes method has been added. Also, the GPX formatter now may take the my_notes=gc:personal_note parameter.
New GGZ formatter has been added. You can also use it with the older garmin formatter by providing the caches_format parameter.
The http://www.opencaching.org.uk/ has been removed from the official list OKAPI installations. It still works, but it has not been updated in years, and we cannot get in touch with its admin.
New OC+OKAPI installation is "live": http://www.opencaching.ro/.
New search parameters supported: powertrail_only and powertrail_ids (only on some OC sites).
Basic support for user-supplied "custom" coordinates (only on some OC sites): See location_source parameter of nearest and bbox methods, location_source_prefix of GPX formatter, and new user-coords alt_wpts type.

The attrs module and other new features

2013-10-31T21:32:00.000+01:00

Some of the new OKAPI features added over the last months (r776-r896):

Introducing the new attrs module.

It allows you to retrieve attribute names and descriptions along with basic icons (provided by the local OC server).

See the attribute method for the full list of available data fields.
List all available attributes with the attribute_index method.

OKAPI uses global attribute IDs called A-codes to reference attributes. Attribute names and descriptions are also global (we store them in our repository). You're welcome to send us translations for your language.
By "global" we mean that they are shared between all OKAPI installations. A single A-code refers to exactly the same attribute on OCPL, OCDE or any other installation.

New fields in the geocache method: gc_code, hint2, hints2, attr_acodes, protection_areas.
The hint and hints fields of the geocache method are now deprecated (why?).
The attrs parameter of the gpx formatter can now support multiple options (instead of just one). Also, two new values for this parameter were added: gc:attrs and gc_ocde:attrs.
New protection_areas parameter was added to the gpx formatter.
oc_team_entry field added to the logs/entry family of methods.

Welcome, OKAPI Germany!

2013-04-30T10:36:00.000+02:00

Finally, after almost two years since its launch, OKAPI has been installed on Opencaching.DE! We encourage the developers of all existing OKAPI applications to add this new node to their apps.

http://www.opencaching.de/okapi/

Also, there were many new features added since the beginning of this year (r776):

You can now submit Will attend and Attended log entries (for the Event caches).
Added the mark method (for marking the caches as watched or ignored).
Added attribution_append parameter to the geocache method.
Added log_fields parameter to the geocache method.
Added descrefs:thumblinks option to the images parameter of the gpx formatter method.
Added many new fields to the geocache method:

willattends,
trip_time,
trip_distance,
preview_image,
attribution_note,
country,
state,
is_watched,
is_ignored.

Added type and type_name keys to the descriptions of additional waypoints returned in the alt_wpts field of the geocache method.
Added watched_only parameter to the searching methods.
Added new fields to the log entry method: was_recommended, images, internal_id.
Added comment_format parameter to the submit method.
Fixed some minor bugs and clarified documentation in all the existing methods.

OKAPI Browser

2012-12-08T14:31:00.000+01:00

Recently, we published a simple project called OKAPI Browser.

It is open-source, written in C#.NET and WPF platform. You can fork it, play with it, submit you patches, or you can simply run the Installer for Windows.

Being made crude and fast, it is not as stable as we'd like, but it still might be a handy tool for some of you (i.e. when you want to test a method which requires OAuth).

Also, there were some minor changes made to OKAPI last month (r518):

A new caches/search/save method was added.
Three new parameters were added to the searching methods: with_trackables_only, ftf_hunter and set_and.

November update

2012-11-10T10:56:00.000+01:00

What changed since June (r495):

size2 and oxsize fields added to the geocache description (and the replicate module).
size2 parameter added to the searching methods.
size fields and search filters are deprecated, developers should use size2 instead. The deprecated fields and parameters will continue to work, but you should avoid them. More information.
xmlmap2 output format added, xmlmap format is now deprecated. More information.
needs_maintenance parameter added to the submit method.
exclude_ignored search filter added.
rating search filter now supports the "|X" suffix.
owner_uuid search filter now supports the "-" prefix.

New features in June

2012-07-15T16:44:00.000+02:00

Features added last month (r404):

Added is_not_found field to the geocache objects.
Added some new features to use when submitting a new log entry: on_duplicate to prevent duplicate log entries, recommend allows users to recommend the geocache, needs_maintenance allows them to notify that the cache needs maintenance.
Added some new statistics fields to user objects: cache_found, caches_notfound, caches_hidden, rcmds_given.
New interactivity option gives you some more control when authorizing your users.

Welcome, Opencaching Netherlands!

2012-06-10T22:31:00.000+02:00

OKAPI have been installed on a new OC server:

http://www.opencaching.nl/okapi/

New features in May

2012-05-31T00:19:00.001+02:00

Key changes this month (r344):

New (parsable) HTTP 4xx error responses. Useful for OAuth Consumers.
services/caches/search/by_urls method added.

OKAPI usage stats

2012-04-19T09:40:00.008+02:00

It's been 8 months since OKAPI Project has started. It is still a very young project, but the list of OKAPI applications is slowly (but steadily) growing. Here are some current stats (for OpenCaching.PL site only):

A total of 66 apps were registered.

23 of these are "alive" (they make requests on a regular basis).
7 of these make use of Level 3 Authentication.

392 distinct users have authorized at least one application with OAuth.

A total of 711 log entries (by 82 users) have been submitted using 2 external apps.
An accurate number of all OKAPI users cannot be determined, because some of them use applications with Level 1 Authentication only.

On average, OKAPI receives 13000 requests per week.

Performance tips

Search with one request, not two

Usually, you should use search_and_retrieve method for searching geocaches with OKAPI. This is usually much faster than calling nearest method first, and then geocaches method with the result of the previous one (unless you cache the results and retrieve only new ones, which is a good technique).

About web scraping

This report does not include requests made with web scraping technique, and we know some of you make such. Web scraping (parsing HTML from web pages) is both unsafe and slow:

Your web-scraping applications will probably stop working every time we change something in site design or structure (and we do that sometimes). Whereas OKAPI methods are meant to be permanently backward-compatible, so you don't have to worry about that.
With web-scraping, you have to download a lot of unnecessary data (headers, menus etc.). OKAPI lets you choose precisely which data you want, resulting in both much faster server response time and much smaller download.
In general, OKAPI methods offer more parameters and they work faster than their HTML caunterparts.
If you already use web scraping, then upgrading to OKAPI should be a relatively simple task. Give it a try!

New features: is_found/mark_found

2012-04-15T09:25:00.003+02:00

New in OKAPI (r332):

Added is_found field to geocache objects.
Added mark_found parameter to GPX formatter.

You can work with both of these using simple Level 1 Authentication. Useful when you want to mark found caches on your maps.

Started OKAPI News Blog

2012-04-08T09:07:00.009+02:00

Welcome, OKAPI developers!

We will start this blog with listing all features added in the last three monts (if you haven't browsed OKAPI documentation pages thoroughly, you might have skipped some):

Added Garmin cache list formatter, designed to work specifically with Garmin GPS devices. Currently it allows to download a Garmin-compatible ZIP file with cache descriptions and photos.
GPX files now may include information on trackables and recommendations (as do geocache objects).
Added my_notes field to geocache objects (Level 3). It can be used to access user's personal notes on the cache.
Added alt_wpts field to geocache objects - alternate waypoints which might be useful when searching for the cache.
Added distance and bearing fields to geocache objects. Useful if you're not sure how to calculate them yourself.
Added pagination and ordering to cache searching methods.
Added pagination to cache's log entries list.
(!) Added the replicate module. It allows you to replicate (and easily keep up-to-date) the entire database of caches and log entries.

All of these features are available in the newest OKAPI revision (r323). Keep in mind, that not all installations have the newest version of OKAPI installed.