Safe Stamper Web API - Revision history

Adminwiki: 29 revisions imported

2021-05-07T08:07:26Z

29 revisions imported

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

2016-04-19T11:04:32Z

← Older revision		Revision as of 11:04, 19 April 2016
Line 15:		Line 15:

	* [[Safe Stamper Web API parameters signature]]		* [[Safe Stamper Web API parameters signature]]


	== API operations ==		== API operations ==
	* [[stamp]]: Send URLs to certificate		* [[stamp]]: Send URLs to certificate
	* [[status]]: Check the status of a certification job		* [[status]]: Check the status of a certification job


	== Callbacks ==		== Callbacks ==

2016-04-19T11:03:26Z

← Older revision		Revision as of 11:03, 19 April 2016
Line 5:		Line 5:

	To get your pair of API keys, you can contact us through [https://www.safestamper.com/contact Safe Stamper contact form]		To get your pair of API keys, you can contact us through [https://www.safestamper.com/contact Safe Stamper contact form]

	~~= Parameters signature =~~

	= API reference =		= API reference =

2016-04-19T11:03:15Z

API reference

← Older revision		Revision as of 11:03, 19 April 2016
Line 12:		Line 12:
	All operations may be called by POST or GET, and return their results in JSON format.		All operations may be called by POST or GET, and return their results in JSON format.

	~~For authentication, all requests must include a signature parameter calculated from the request parameters and the API client private key. [[Safe Stamper Web API parameters signature]]~~		== Authentication ==

			For authentication, all requests must include a signature parameter calculated from the request parameters and the API client private key.

			* [[Safe Stamper Web API parameters signature]]


			== API operations ==
	* [[stamp]]: Send URLs to certificate		* [[stamp]]: Send URLs to certificate
	* [[status]]: Check the status of a certification job		* [[status]]: Check the status of a certification job


			== Callbacks ==
	When calling [[stamp]] you can provide a callback URL:		When calling [[stamp]] you can provide a callback URL:

	* [[Safe Stamper Web API callbacks]]		* [[Safe Stamper Web API callbacks]]

2016-04-19T11:02:28Z

← Older revision		Revision as of 11:02, 19 April 2016
Line 8:		Line 8:
	= Parameters signature =		= Parameters signature =

	~~[[Safe Stamper Web~~ API ~~parameters signature]]~~		= API reference =

	~~= API~~ operations =		All operations may be called by POST or GET, and return their results in JSON format.

	~~All operations may be called by POST or GET~~, and ~~return their results in JSON format~~.		For authentication, all requests must include a signature parameter calculated from the request parameters and the API client private key. [[Safe Stamper Web API parameters signature]]

	* [[stamp]]: Send URLs to certificate		* [[stamp]]: Send URLs to certificate

2016-04-19T10:57:30Z

← Older revision		Revision as of 10:57, 19 April 2016
Line 20:		Line 20:

	* [[Safe Stamper Web API callbacks]]		* [[Safe Stamper Web API callbacks]]

	~~= Callbacks =~~

2016-04-19T10:55:39Z

API operations

← Older revision		Revision as of 10:55, 19 April 2016
Line 16:		Line 16:
	* [[stamp]]: Send URLs to certificate		* [[stamp]]: Send URLs to certificate
	* [[status]]: Check the status of a certification job		* [[status]]: Check the status of a certification job

			When calling [[stamp]] you can provide a callback URL:

			* [[Safe Stamper Web API callbacks]]

	= Callbacks =		= Callbacks =

2016-04-19T10:54:45Z

Callbacks

← Older revision		Revision as of 10:54, 19 April 2016
Line 17:		Line 17:
	* [[status]]: Check the status of a certification job		* [[status]]: Check the status of a certification job

	= Callbacks =		= Callbacks =

	~~When starting a certification job with [[stamp]] you can provide a callback URL.~~

	~~Once the certification job is finished, the callback URL will receive a POST call with the same JSON object as returned in the [[status]] operation.~~

	~~To authenticate the callback, the request body HMAC-SHA1 will be calculated using the API client private key and will be provided as a query string parameter ''signature''~~

	~~== Example ==~~

	~~Line breaks have been included in this example content for legibility, but actual callbacks include the whole JSON in a single line.~~

	~~<pre>~~
	~~POST /stamper-callback?signature=743ae4504eb41cbfe2d2e72dac76a27613333a53 HTTP/1.1~~
	~~Host: example.com~~
	~~Content-Type: application/json~~
	~~Content-Length: 377~~

	{
	~~"jobId":"c498d3e0-aedb-48fe-82d5-5dec4270318b",~~
	~~"results":[~~
	~~{"url":"http://www.safestamper.com","status":"READY","certificateId":"160419-BQS763","certificateUrl":"https://arena-web.safestamper.com/certificate/160419-BQS763"},~~
	~~{"url":"NON-VALID-URL","status":"ERROR","error":"bad-url"},~~
	~~{"url":"http://www.safecreative.org","status":"READY","certificateId":"160419-2LYD3K","certificateUrl":"https://arena-web.safestamper.com/certificate/160419-2LYD3K"}~~
	]
	}
	~~</pre>~~

2016-04-19T10:54:27Z

2016-04-19T10:54:07Z

Example

← Older revision		Revision as of 10:54, 19 April 2016
Line 26:		Line 26:

	== Example ==		== Example ==

			Line breaks have been included in this example content for legibility, but actual callbacks include the whole JSON in a single line.

	<pre>		<pre>
	POST /stamper-callback HTTP/1.1		POST /stamper-callback?signature=743ae4504eb41cbfe2d2e72dac76a27613333a53 HTTP/1.1
	Host: example.com		Host: example.com
	Content-Type: application/json		Content-Type: application/json
	Content-Length: 377		Content-Length: 377

	{"jobId":"~~f39f2d5c~~-~~4bc6~~-~~4a15~~-~~90b5~~-~~00ebf69d0268~~","results":[{"url":"www.safestamper.com","status":"READY","certificateId":"160419-~~N3MBMN~~","certificateUrl":"https://arena-web.safestamper.com/certificate/160419-~~N3MBMN~~"},{"url":"www.safecreative.org","status":"READY","certificateId":"160419-~~G4B7BL~~","certificateUrl":"https://arena-web.safestamper.com/certificate/160419-~~G4B7BL~~"}]}		{
			"jobId":"c498d3e0-aedb-48fe-82d5-5dec4270318b",
			"results":[
			{"url":"http://www.safestamper.com","status":"READY","certificateId":"160419-BQS763","certificateUrl":"https://arena-web.safestamper.com/certificate/160419-BQS763"},
			{"url":"NON-VALID-URL","status":"ERROR","error":"bad-url"},
			{"url":"http://www.safecreative.org","status":"READY","certificateId":"160419-2LYD3K","certificateUrl":"https://arena-web.safestamper.com/certificate/160419-2LYD3K"}
			]
			}
	</pre>		</pre>

	= Example =		= Example =