OKAPI: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(update) |
||
| Line 1: | Line 1: | ||
[[Category:Projects]] | [[Category:Projects]] | ||
== | The description below is primarily for OC administrators ''AND'' people who want | ||
to help implement OKAPI backend. | |||
__NOTOC__ | |||
== About OKAPI == | |||
[[File:Okapi-xsmall.png|alt=OKAPI|frame]] | [[File:Okapi-xsmall.png|alt=OKAPI|frame]] | ||
'''OKAPI is a publically available [http://en.wikipedia.org/wiki/Application_programming_interface API] for "National Opencaching" sites.''' | |||
* It provides OC site with a set of useful well-documented API methods, | * It provides OC site with a set of useful well-documented API methods, | ||
* Allows external developers to easily read public Opencaching data, | * Allows external developers to easily read public Opencaching data, | ||
* Allows read and write private (user-related) data with OAuth Authentication. | * Allows read and write private (user-related) data with OAuth Authentication. | ||
The project has grown to become a standard and common API for all National Opencaching.xx sites. | The project has grown to become a standard and common API for all National Opencaching.xx sites. | ||
OKAPI is an integral part of the [[Opencaching-PL]] code fork, i.e. an OCPL site will run properly only with OKAPI installed. For the [[Opencaching-DE]] code fork, OKAPI is an optional plugin - all other services of the site will run independently from OKAPI. | |||
== List of OKAPI installations == | |||
* Opencaching.PL - http://opencaching.pl/okapi/ | * Opencaching.PL - http://opencaching.pl/okapi/ | ||
* Opencaching.DE<ref>Opencaching.DE includes other sites - Opencaching.IT, OpencachingSpain.ES and Opencaching.FR - which are in fact the one site visible on multiple domains. All three share one database, so you can access all their data through Opencaching.DE OKAPI installation. | * Opencaching.DE<ref>Opencaching.DE includes other sites - Opencaching.IT, OpencachingSpain.ES and Opencaching.FR - which are in fact the one site visible on multiple domains. All three share one database, so you can access all their data (only) through Opencaching.DE OKAPI installation. | ||
</ref> - http://www.opencaching.de/okapi/ | </ref> - http://www.opencaching.de/okapi/ | ||
* Opencaching.US - http://www.opencaching.us/okapi/ | * Opencaching.US - http://www.opencaching.us/okapi/ | ||
* Opencaching.NL - http://www.opencaching.nl/okapi/ | * Opencaching.NL - http://www.opencaching.nl/okapi/ | ||
* Opencaching.RO - http://www.opencaching.ro/okapi/ | * Opencaching.RO - http://www.opencaching.ro/okapi/ | ||
* OC.DE test site - http://test.opencaching.de/okapi/ | |||
== Other links you might want to check out == | |||
* OKAPI Project Homepage - https://github.com/opencaching/okapi/ | * OKAPI Project Homepage - https://github.com/opencaching/okapi/ | ||
* OKAPI News blog - http://opencaching-api.blogspot.com/ | * OKAPI News blog - http://opencaching-api.blogspot.com/ | ||
== References == | |||
<references /> | |||
Revision as of 01:37, 30 May 2016
The description below is primarily for OC administrators AND people who want to help implement OKAPI backend.
About OKAPI
OKAPI is a publically available API for "National Opencaching" sites.
- It provides OC site with a set of useful well-documented API methods,
- Allows external developers to easily read public Opencaching data,
- Allows read and write private (user-related) data with OAuth Authentication.
The project has grown to become a standard and common API for all National Opencaching.xx sites.
OKAPI is an integral part of the Opencaching-PL code fork, i.e. an OCPL site will run properly only with OKAPI installed. For the Opencaching-DE code fork, OKAPI is an optional plugin - all other services of the site will run independently from OKAPI.
List of OKAPI installations
- Opencaching.PL - http://opencaching.pl/okapi/
- Opencaching.DE[1] - http://www.opencaching.de/okapi/
- Opencaching.US - http://www.opencaching.us/okapi/
- Opencaching.NL - http://www.opencaching.nl/okapi/
- Opencaching.RO - http://www.opencaching.ro/okapi/
- OC.DE test site - http://test.opencaching.de/okapi/
Other links you might want to check out
- OKAPI Project Homepage - https://github.com/opencaching/okapi/
- OKAPI News blog - http://opencaching-api.blogspot.com/
References
- ↑ Opencaching.DE includes other sites - Opencaching.IT, OpencachingSpain.ES and Opencaching.FR - which are in fact the one site visible on multiple domains. All three share one database, so you can access all their data (only) through Opencaching.DE OKAPI installation.