API for OpenCaching.DE (and other sites)

[wrygiel]

This topic is for developers, but not only to OpenCaching.DE developers,
but also all other programmers interested in having an API for OpenCaching.DE.
That's why I am posting it in the public section.

Some OC sites already have public APIs, I am a developer on one of them,
maybe some of you have already stumbled upon it:

http://opencaching.pl/okapi/

The same API is installed also at opencaching.us and opencaching.org.uk.
It is also compatible with opencaching.de, but not yet installed there.
But I hope it will be - OC.DE admins keep saying that they will do it "soon"

Anyway, I would like to hear your comments about my project!

Would you use it? What would you like to change in it (based on what you
can see at opencaching.pl)? Or, perhaps, you'd like an additional client library
for Java (Android) or PHP included?

Thanks for any suggestions!

PS. OKAPI is [url=http://code.google.com/p/opencaching-api/]open-source[/url] and we have a [url=http://code.google.com/p/opencaching-api/issues/list]bugtracker[/url] at google code which
you can also use if you prefer that over forum.

[dl6hbo]

Hi wrygiel,
at opencaching.de we are currently in the process of founding the German equivalent of a non-profit organization, as a carrier for our future activities.  Please let us have all the time we need to do so.  Once the task is finished, our developers will sure be happy to contact you and talk shop.

Regards,
Rainer

[wrygiel]

Hello dl6hbo,

Yes, I've heard about your issues (I've been writing with some of you for some time).
I hope it all goes well

I am simply looking forward to hearing some comments of other developers from Germany
potentially interested in OKAPI. (For example, what kind of data do they scrape of the website
and would like API to include.)

[dl6hbo]

Hi wrygiel,

thanks for your reply.  Yes I do as well hope all goes well. Keep your fingers crossed !

[harrieklomp]

Also oc.nl has to wait for oc.de and also we do not know what changes there will be made.

[wrygiel]

[quote="harrieklomp"]
Also oc.nl has to wait for oc.de
[/quote]

Maybe it's a stupid question, but - why?

I don't know much about "relationships" between OC nodes, but I always though them to be completely independant servers with their own code.

For example, half a year ago I wrote to admins at OC.US and OC.ORG.UK and they have installed OKAPI without much problems. Even though they do not run on the same code as OC.PL (they have a very similar database though).

[harrieklomp]

[quote="wrygiel"]


Maybe it's a stupid question, but - why?

I don't know much about "relationships" between OC nodes, but I always though them to be completely independant servers with their own code.

For example, half a year ago I wrote to admins at OC.US and OC.ORG.UK and they have installed OKAPI without much problems. Even though they do not run on the same code as OC.PL (they have a very similar database though).
[/quote]

We have the same code as oc.de but only the language has been translated and some minor things in some files.
In this case it was supposed that when there is a update all sites like oc.es, oc.it and oc.nl can updated in one go.
I am the only one left with very little knowledge about the site, i am not a programmer or developer, so i am depending from the friends from Germany for help if i need it 

[wrygiel]

If you'd allow me, I would like to have a look at your server. I won't change anything "visible", I would just test for OKAPI compatibility and report the results later. Could you write me at rygielski@mimuw.edu.pl?

[michasch]

If I remember correctly, there are two main issues (three if you count the currently ongoing change of operator) preventing the OCAPI to be used at OC.de:
- first the PHP version is currently too low on our server - we're in progress doing an upgrade of all the servers software, but changing operator of the site got more priority.
- second there is some additional business logic compared to OC.pl node. In germany an additional status "locked, hidden" is present mainly used in case of legal difficulties (and some minor other differences). Those caches MUSTN'T be available via API under all circumstances, as you may easily understand.
Because of your API accessing the database directly and not by using our php-business logic the API must be carefully reviewed so there is no possibility to do things or to see caches or other information not available at the website.

Best regards,
Michael

[wrygiel]

Hi michasch,

As to the second problem - this doesn't seem much of a problem, we'll make OKAPI ignore database entries with unknown statuses. We'll deal with all such issues when you'll have your new server ready. This shouldn't be hard.

Maybe you'd be interested in running a beta-test on opencaching.nl?

[wrygiel]

Hello again,

I would like to inform you that I made OKAPI compatible with OCNL code
(and hence, OCDE code too, I guess). Here is a full report on the differences
I found and fixed:

http://code.google.com/p/opencaching-api/wiki/opencaching_nl

I also set up a beta vesion of OKAPI on OpenCaching.NL server.
I think OKAPI is now compatible with all OC nodes.

[wrygiel]

[quote="michasch"]
In germany an additional status "locked, hidden" is present mainly used in case of legal difficulties (and some minor other differences). Those caches MUSTN'T be available via API
[/quote]

I think this part of the code is the same as in OCPL. OCPL has six statuses (1-6), only the the first three (1-3) can be displayed (and only 1-3 can be accessed via OKAPI). You have more of them?

[following]

[quote="wrygiel"]
I think this part of the code is the same as in OCPL. OCPL has six statuses (1-6), only the the first three (1-3) can be displayed (and only 1-3 can be accessed via OKAPI). You have more of them?
[/quote]

Yes, there is state 7 = locked & invisible.

[mic@]

[quote="wrygiel"]Some OC sites already have public APIs, I am a developer on one of them,
maybe some of you have already stumbled upon it:

http://opencaching.pl/okapi[/quote]

Where do I find the terms of service?

[Schrottie]

[quote="mic@"]
Where do I find the terms of service?
[/quote]

http://opencaching.pl/okapi/signup.html