API Overview - Revision history

Adminwiki at 11:32, 20 April 2022

2022-04-20T11:32:26Z

← Older revision		Revision as of 11:32, 20 April 2022
Line 90:		Line 90:

	You create an authkey with [[authkey.create]]. Then you must redirect your user to the user authorization page, where he must complete the authorization process. Once authorization is complete, user will be redirected to you user bringback URL.		You create an authkey with [[authkey.create]]. Then you must redirect your user to the user authorization page, where he must complete the authorization process. Once authorization is complete, user will be redirected to you user bringback URL.

			= Nonce key =

			See [[Nonce key]]

			Some API operations require additional security through the use of a one-time nonce key.

	= Callbacks =		= Callbacks =

2021-05-07T08:07:12Z

69 revisions imported

← Older revision	Revision as of 08:07, 7 May 2021
(No difference)

2017-02-08T08:54:52Z

API architecture

← Older revision		Revision as of 08:54, 8 February 2017
Line 1:		Line 1:
	= API architecture =		= API architecture =
	[[File:Arquitecture.png\|frame\|API architecture]]		[[File:Arquitecture.png\|frame\|API architecture]]
	Safe Creative API is a REST-like interface to Safe Creative services. It is stateless and is divided in 4 main areas		Safe Creative API is a REST-like interface to Safe Creative services. It is stateless and is divided in 3 main areas
	* '''Core''': Main services accessible through <tt><nowiki>http://api.safecreative.org</nowiki></tt>		* '''Core''': Main services accessible through <tt><nowiki>http://api.safecreative.org</nowiki></tt>
	* '''Upload''': API for uploading works, accessible through several dedicated upload servers (see [[work.upload.lookup]])		* '''Upload''': API for uploading works, accessible through several dedicated upload servers (see [[work.upload.lookup]])
	* '''Search''': ~~Services~~ for searching works ~~accessible through <tt><nowiki>http://api-search.safecreative.org</nowiki></tt>~~		* '''Search''': Public services for searching works
	* '''Semantic''': Semantic services accessible through <tt><nowiki>http://api-search.safecreative.org</nowiki></tt>

	There are three trust levels for applications using Safe Creative API		There are three trust levels for applications using Safe Creative API

2011-03-03T13:41:02Z

Added jsonp

← Older revision		Revision as of 13:41, 3 March 2011
Line 64:		Line 64:
	* '''authkey''' is the user authorization for the application to use his account. It has an associated private key.		* '''authkey''' is the user authorization for the application to use his account. It has an associated private key.
	* '''signature''' is a hash of the request computed using the private key associated to the sharedkey or authkey (depending on the component being called). See [[signature parameter]].		* '''signature''' is a hash of the request computed using the private key associated to the sharedkey or authkey (depending on the component being called). See [[signature parameter]].
	* '''format''' specifies the response format: xml (default) or ~~json~~		* '''format''' specifies the response format: xml (default),json or [[jsonp]]

	Read the [[API reference]] to know the parameters expected by each component. Non-required parameters can be omitted from a component call.		Read the [[API reference]] to know the parameters expected by each component. Non-required parameters can be omitted from a component call.

2010-10-15T10:37:34Z

Fixed typo

← Older revision		Revision as of 10:37, 15 October 2010
Line 96:		Line 96:
	See [[API callbacks]]		See [[API callbacks]]

	The API server will use your callback URL to send your application several notifications.		The API server will use your callback URL to send to your application several notifications.

	= Error handling =		= Error handling =

2010-10-15T08:12:08Z

Obtaining the keys to use the API

← Older revision		Revision as of 08:12, 15 October 2010
Line 31:		Line 31:

	After some time you will obtain the activation of these keys, so you can use the Safe Creative API (you will be notified by email).		After some time you will obtain the activation of these keys, so you can use the Safe Creative API (you will be notified by email).

	Once you have obtained an API key, you can manage your API keys from the ''Applications'' tab on your [https://www.safecreative.org/myaccount/tab/USERKEYS_AUTHS Safe Creative account]		Once you have obtained an API key, you can manage your API keys from the ''Applications'' tab on your [https://www.safecreative.org/myaccount/tab/USERKEYS_AUTHS Safe Creative account]

2010-10-15T08:07:24Z

bringback url

← Older revision		Revision as of 08:07, 15 October 2010
Line 27:		Line 27:
	* Web site: Public URL of the site of the application		* Web site: Public URL of the site of the application
	* API callback URL: Private URL used by Safe Creative to notify different types of events. See [[API callbacks]]		* API callback URL: Private URL used by Safe Creative to notify different types of events. See [[API callbacks]]
	* API bringback URL: ~~URL provided to the client user as the final step of key authorization. i.e., user will be redirect to this url after authorizing your application.~~ See [[~~User authorization~~]].		* API bringback URL: See [[Bringback url]].
	* Notes: Private notes for the Safe Creative Team in order to obtain the activation of the keys		* Notes: Private notes for the Safe Creative Team in order to obtain the activation of the keys

2010-05-31T07:05:10Z

Request signature

← Older revision		Revision as of 07:05, 31 May 2010
Line 79:		Line 79:
	See [[Signature parameter]]		See [[Signature parameter]]

	Many operations require a signature of the request~~, this~~ signature is the SHA-1 hash of the arguments sorted by key, preceded by a private key.		Many operations require a signature of the request. This signature is the SHA-1 hash of the arguments, sorted by key, and preceded by a private key.

	The private key to use depends on the component being called. If the component requires an authkey, then the private key to use is the one associated to that authkey. In other cases, you must use the private key associated to your shared key.		The private key to use depends on the component being called. If the component requires an authkey, then the private key to use is the one associated to that authkey. In other cases, you must use the private key associated to your shared key.

2010-05-28T07:04:37Z

Request signature

← Older revision		Revision as of 07:04, 28 May 2010
Line 78:		Line 78:

	See [[Signature parameter]]		See [[Signature parameter]]

			Many operations require a signature of the request, this signature is the SHA-1 hash of the arguments sorted by key, preceded by a private key.

			The private key to use depends on the component being called. If the component requires an authkey, then the private key to use is the one associated to that authkey. In other cases, you must use the private key associated to your shared key.

	= User authorization =		= User authorization =

2010-05-28T07:03:36Z

← Older revision		Revision as of 07:03, 28 May 2010
Line 74:		Line 74:

	Some operations do not require a signature, so you can avoid calculating and sending it. The same can be said for the ztime		Some operations do not require a signature, so you can avoid calculating and sending it. The same can be said for the ztime

			= Request signature =

			See [[Signature parameter]]

	= User authorization =		= User authorization =