OKAPI: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 4: | Line 4: | ||
[[Category:Opencaching-DE]] | [[Category:Opencaching-DE]] | ||
[[Category:Opencaching-PL]] | [[Category:Opencaching-PL]] | ||
The description below is primarily for OC administrators ''AND'' people who want | The description below is primarily for OC administrators ''AND'' people who want to help implement OKAPI backend. | ||
to help implement OKAPI backend. | |||
__NOTOC__ | __NOTOC__ | ||
== About OKAPI == | == About OKAPI == | ||
| Line 12: | Line 11: | ||
'''OKAPI is a publically available [http://en.wikipedia.org/wiki/Application_programming_interface API] for "National Opencaching" sites.''' | '''OKAPI is a publically available [http://en.wikipedia.org/wiki/Application_programming_interface API] for "National Opencaching" sites.''' | ||
* It provides | * It provides Opencaching 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 | OKAPI is an integral part of the [[Opencaching-PL]] code fork, i.e. an Opencaching-PL 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 == | == List of OKAPI installations == | ||
| Line 23: | Line 22: | ||
* 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. | * 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.UK - http://www.opencache.uk/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/ | * OC.DE test site - http://test.opencaching.de/okapi/ | ||
'''Each installation URL (as above) provides full online documentation of OKAPI.''' | |||
== Other links you might want to check out == | == 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/ | ||
= Developer information = | |||
Third party application developers must sign up for an application key on each existing OKAPI instance (''each Opencaching website''). See Signup page on OKAPI online documentation. | |||
=== OKAPI specific data === | |||
OKAPI uses an internal mapping file [https://github.com/opencaching/okapi/blob/master/okapi/services/attrs/attribute-definitions.xml attribute-definitions.xml] for attribute assignments and GC equivalence. | |||
To represent cache attributes in a GC compatible way, OKAPI defines a an internal [[ACODE]] and also generates the [[OCGS]] XML tag in GPX exports. | |||
== References == | == References == | ||
<references /> | <references /> | ||
Latest revision as of 11:52, 5 June 2019
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 Opencaching 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 Opencaching-PL 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.UK - http://www.opencache.uk/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/
Each installation URL (as above) provides full online documentation of 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/
Developer information
Third party application developers must sign up for an application key on each existing OKAPI instance (each Opencaching website). See Signup page on OKAPI online documentation.
OKAPI specific data
OKAPI uses an internal mapping file attribute-definitions.xml for attribute assignments and GC equivalence.
To represent cache attributes in a GC compatible way, OKAPI defines a an internal ACODE and also generates the OCGS XML tag in GPX exports.
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.