Adminwiki: 1 revision imported

2023-10-17T11:27:28Z

1 revision imported

← Older revision	Revision as of 07:27, 17 October 2023
(No difference)

api>Admin at 10:28, 9 December 2016

2016-12-09T10:28:33Z

New page

This operation returns the status of a certification job.

= URL =
<nowiki>https://www.safestamper.com/api/web/status</nowiki>

= Parameters =
* '''sharedkey''': Your API client shared key
* '''jobId''': The job identifier returned by the [[stamp]] operation
* '''signature''': Parameters signature, as explained in [[Signature parameter]]

= Returns =

A JSON object with the following fields:

* '''jobId''': Job identifier
* '''results''': Array of JSON objects with the status of each URL included in the certification job
** '''url''': URL to be certified
** '''status''': URL status, can be one of the following:
*** ''INPROGRESS'': URL certification is in progress
*** ''ERROR'': The URL could not be certified
*** ''READY'': The URL certificate is ready for download
** '''progress''': Percentage of completion (for ''INPROGRESS'' status)
** '''error''': Error code (for ''ERROR'' status):
*** ''bad-url'': URL is not valid
*** ''quota-error'': User has no certificate credits
*** ''quota-disk-error'': User has no storage space
*** ''max-size'': URL content is too large (more than 5Mb)
*** ''too-many-redirects'': URL has launched more than 10 redirects
*** ''http-error-XXX'': URL returned an HTTP status other than 200 (success) or 30X (redirects)
*** ''internal-error'': Unexpected internal error while processing URL certificate
** '''certificateId''': Certificate code (for ''READY'' status)
** '''certificateUrl''': Certificate download URL (for ''READY'' status)

= HTTP Errors =

* '''403''' Forbidden: the sharedkey or signature are not valid, or the specified job does not belong to the API client
* '''404''' Not found: the job id is not correct.

= Example =

REQUEST:
<pre>
https://www.safestamper.com/api/web/status
?sharedkey=5hmpod0d2vx7fnh6ysxab3olz
&jobId=c498d3e0-aedb-48fe-82d5-5dec4270318b
&signature=5784ad59c9fb400451887a138bf8ad36cee729d2
</pre>

RESPONSE (actual response has no line breaks or indentation):
<pre>
{
"jobId":"c498d3e0-aedb-48fe-82d5-5dec4270318b",
"results":[
{"url":"http://www.safestamper.com","status":"READY",
"certificateId":"160419-BQS763",
"certificateUrl":"https://web.safestamper.com/certificate/160419-BQS763"},
{"url":"NON-VALID-URL","status":"ERROR","error":"bad-url"},
{"url":"http://www.safecreative.org","status":"INPROGRESS","progress":66}
]
}
</pre>

Web/status - Revision history

Adminwiki: 1 revision imported

api>Admin at 10:28, 9 December 2016