API callbacks - Revision history

Adminwiki: 15 revisions imported

2021-05-07T08:07:17Z

15 revisions imported

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

2011-06-16T10:41:45Z

@@ Line 36: / Line 36: @@
 ** PREREGISTERED: The work was registered by URL, has been downloaded and enters its pre-registration period
 ** REGISTERED: The work has finished its pre-registrations period (or was registered as final)
 == URL registration failure ==

2011-03-15T14:02:17Z

Added user deleted callback

@@ Line 100: / Line 100: @@
 == User personal data modified ==
-If you are a partner and have created a user account using the [[user.link]] component, you will receive this callback whenever the user modifies his Safe Creative account.
+If you are a partner and have created an user account using the [[user.link]] component, you will receive this callback whenever the user modifies his Safe Creative account.
 <pre>
@@ Line 124: / Line 124: @@
 * code: user's code
 * mail, firstName, middleName, lastName, addressLine1, addressLine2, addressCity, addressCountry: user's current data

2010-11-26T14:46:13Z

Added missing auth callback

@@ Line 62: / Line 62: @@
 ** unauthorized: The api key used to register this work is not authorized
 ** missing-auth: The api key used to register this work is not available
 == User authorization deleted ==

2010-10-14T12:56:21Z

URL registration failure

← Older revision		Revision as of 12:56, 14 October 2010
Line 46:		Line 46:
	&code=0907240000817		&code=0907240000817
	&url={your_work_url}		&url={your_work_url}
	&status=~~404~~		&status=failed
	&signature=b43f1942381b9ea77449932478e488e4ff43a244		&signature=b43f1942381b9ea77449932478e488e4ff43a244
	</pre>		</pre>
Line 54:		Line 54:
	* url: URL where the work was tried to be downloaded from		* url: URL where the work was tried to be downloaded from
	* status: Status code		* status: Status code
	** ~~FILE_SIZE_MISMATCH~~: Downloaded file size does not match the one provided		** failed: Download has failed
	** ~~CHECKSUM_SIZE_MISMATCH~~: Downloaded file checksum does not match the one provided		** filesize-mismatch: Downloaded file size does not match the one provided
	** ~~WORK_NOT_FOUND~~: Work has been deleted before download was completed		** checksum-mismatch: Downloaded file checksum does not match the one provided
	** ~~UNEXPECTED_WORKSTATE~~: Work is already registered		** notfound: Work has been deleted before download was completed
	** ~~DEFAULT_DOWNLOAD_FAILED~~: ~~Download has failed~~		** unexpected-workstate: Work is in an unexpected registation state
			** already-registered: Work is already registered
			** unauthorized: The api key used to register this work is not authorized
			** missing-auth: The api key used to register this work is not available

	== User authorization deleted ==		== User authorization deleted ==

2010-06-14T11:07:22Z

← Older revision		Revision as of 11:07, 14 June 2010
Line 45:		Line 45:
	&ztime=1248523203872		&ztime=1248523203872
	&code=0907240000817		&code=0907240000817
	&url=~~http://domain.fake/~~your_work_url		&url={your_work_url}
	&status=404		&status=404
	&signature=b43f1942381b9ea77449932478e488e4ff43a244		&signature=b43f1942381b9ea77449932478e488e4ff43a244

2010-05-06T11:01:18Z

← Older revision		Revision as of 11:01, 6 May 2010
Line 78:		Line 78:

	== User personal data modified ==		== User personal data modified ==
	If you are a partner and have created a user account using the [[user.link ~~component~~]], you will receive this callback whenever the user modifies his Safe Creative account.		If you are a partner and have created a user account using the [[user.link]] component, you will receive this callback whenever the user modifies his Safe Creative account.

	<pre>		<pre>

2010-05-06T10:55:11Z

← Older revision		Revision as of 10:55, 6 May 2010
Line 53:		Line 53:
	* code: work code		* code: work code
	* url: URL where the work was tried to be downloaded from		* url: URL where the work was tried to be downloaded from
	* status: ~~HTTP status~~ code ~~received when trying to~~ download ~~the work~~		* status: Status code
			** FILE_SIZE_MISMATCH: Downloaded file size does not match the one provided
			** CHECKSUM_SIZE_MISMATCH: Downloaded file checksum does not match the one provided
			** WORK_NOT_FOUND: Work has been deleted before download was completed
			** UNEXPECTED_WORKSTATE: Work is already registered
			** DEFAULT_DOWNLOAD_FAILED: Download has failed

	== User authorization deleted ==		== User authorization deleted ==

2010-05-05T07:03:09Z

← Older revision		Revision as of 07:03, 5 May 2010
Line 15:		Line 15:
	Where <code>component</code> is the notification "type" or source.		Where <code>component</code> is the notification "type" or source.

	The callback is signed with the private key associated to your shared key and is ztime-stamped so you can verify the authenticity of the call. It's recommeded to define the callback url as ~~https~~.		The callback is signed with the private key associated to your shared key and is ztime-stamped so you can verify the authenticity of the call. It's recommeded to define the callback url as HTTPS.


	= Callback types =		= Callback types =

2010-05-05T07:02:39Z

← Older revision		Revision as of 07:02, 5 May 2010
Line 1:		Line 1:
	The Safe Creative API can sometimes send your application different notifications through your callback URL, which you can enter when you request you API keys (or edit at any moment once your API key has been activated).		The Safe Creative API can sometimes send your application different notifications through your callback URL, which you can enter when you request you API keys (or edit at any moment once your API key has been activated).

			You may receive the same notification more than once, though it is not common.

	= Syntax =		= Syntax =