OKAPI - Revision history

Andrixnet at 10:52, 5 June 2019

2019-06-05T10:52:56Z

← Older revision		Revision as of 12:52, 5 June 2019
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 OC site with a set of useful well-documented API methods,		* 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 ~~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.		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 39:		Line 38:

	=== OKAPI specific data ===		=== 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.		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 />

Andrixnet: added some more details

2019-06-05T09:34:37Z

added some more details

← Older revision		Revision as of 11:34, 5 June 2019
Line 23:		Line 23:
	* 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 ===
			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 />

Andrixnet at 10:57, 14 May 2019

2019-05-14T10:57:44Z

← Older revision		Revision as of 12:57, 14 May 2019
Line 1:		Line 1:
			[[Category:Opencaching]]
	[[Category:Projects]]		[[Category:Projects]]
	[[Category:API]]		[[Category:API]]

Andrixnet at 07:29, 14 May 2019

2019-05-14T07:29:58Z

← Older revision		Revision as of 09:29, 14 May 2019
Line 1:		Line 1:
	[[Category:Projects]]		[[Category:Projects]]
			[[Category:API]]
			[[Category:Opencaching-DE]]
			[[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.

Following: update

2016-05-30T00:37:53Z

update

← Older revision		Revision as of 02:37, 30 May 2016
Line 1:		Line 1:
	[[Category:Projects]]		[[Category:Projects]]
	== ~~What is~~ OKAPI? ==		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 ~~plugin~~ for National Opencaching~~.XX~~ sites. ~~===~~		'''OKAPI is a publically available [http://en.wikipedia.org/wiki/Application_programming_interface API] for "National Opencaching" sites.'''
	~~The description below is primarily for OC administrators~~ ''~~AND~~'~~' people who want~~
	~~to help implement OKAPI backend.~~

	~~==== 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.

	~~'''Here~~ is the ~~list~~ of ~~other~~ OKAPI installations~~:'''~~		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/
	~~'''~~Other links you might want to check out~~:'''~~		* 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 />

Andrixnet at 11:40, 29 May 2016

2016-05-29T11:40:28Z

← Older revision		Revision as of 13:40, 29 May 2016
Line 1:		Line 1:
			[[Category:Projects]]
	== What is OKAPI? ==		== What is OKAPI? ==
	[[File:Okapi-xsmall.png\|alt=OKAPI\|frame]]		[[File:Okapi-xsmall.png\|alt=OKAPI\|frame]]

Andrixnet at 09:33, 29 May 2016

2016-05-29T09:33:52Z

← Older revision		Revision as of 11:33, 29 May 2016
Line 1:		Line 1:
	== What is OKAPI? ==		== What is OKAPI? ==
			[[File:Okapi-xsmall.png\|alt=OKAPI\|frame]]

	=== OKAPI is a plugin for National Opencaching.XX sites. ===		=== OKAPI is a plugin for National Opencaching.XX sites. ===

Andrixnet at 08:56, 29 May 2016

2016-05-29T08:56:57Z

← Older revision		Revision as of 10:56, 29 May 2016
Line 2:		Line 2:

	=== OKAPI is a plugin for National Opencaching.XX sites. ===		=== OKAPI is a plugin for National Opencaching.XX sites. ===
			The description below is primarily for OC administrators ''AND'' people who want
			to help implement OKAPI backend.

	==== 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 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.

	'''Here is the list of other OKAPI installations:'''		'''Here is the list of other 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>*</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/

	'''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/]

	* - 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.

Andrixnet: Created page with "== What is OKAPI? == === OKAPI is a plugin for National Opencaching.XX sites. === ==== OKAPI is a publically available [http://en.wikipedia.org/wiki/Application_programming_..."

2016-05-29T08:52:45Z

Created page with "== What is OKAPI? == === OKAPI is a plugin for National Opencaching.XX sites. === ==== OKAPI is a publically available [http://en.wikipedia.org/wiki/Application_programming_..."

New page

== What is OKAPI? ==

=== OKAPI is a plugin for National Opencaching.XX sites. ===

==== 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,
* 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.

'''Here is the list of other OKAPI installations:'''

* Opencaching.PL - [http://opencaching.pl/okapi/]
* Opencaching.DE<ref>*</ref> - [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/]

'''Other links you might want to check out:'''

OKAPI Project Homepage - [https://github.com/opencaching/okapi/]
OKAPI News blog - [http://opencaching-api.blogspot.com/]

* - 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.