Status: Difference between revisions
Jump to navigation
Jump to search
w>Jguillo No edit summary |
w>Jguillo |
||
Line 30: | Line 30: | ||
= Example = | = Example = | ||
REQUEST: | |||
<pre> | |||
https://web.safestamper.com/api/status | |||
?sharedkey=5hmpod0d2vx7fnh6ysxab3olz | |||
&jobId=f39f2d5c-4bc6-4a15-90b5-00ebf69d0268 | |||
&signature=33e27a515f1478d00abcce577205e2f54e6d94f2 | |||
</pre> | |||
RESPONSE: | |||
<pre> | |||
{ | |||
"jobId":"f39f2d5c-4bc6-4a15-90b5-00ebf69d0268", | |||
"results":[ | |||
{"url":"www.safestamper.com","status":"READY","certificateId":"160419-N3MBMN","certificateUrl":"https://web.safestamper.com/certificate/160419-N3MBMN"}, | |||
{"url":"www.safecreative.org","status":"INPROGRESS"} | |||
] | |||
} |
Revision as of 10:34, 19 April 2016
This operation returns the status of a certification job.
URL
https://web.safestamper.com/api/status
Parameters
- sharedkey: Your API client shared key
- jobId: The job identifier returned by the stamp operation
- signature: Parameters signature, as explained in Safe Stamper Web API parameters signature
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: The URL has not been certificated yet
- ERROR: The URL could not be certified
- READY: The URL certificate is ready for download
- error: Error description (for ERROR status)
- 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:
https://web.safestamper.com/api/status ?sharedkey=5hmpod0d2vx7fnh6ysxab3olz &jobId=f39f2d5c-4bc6-4a15-90b5-00ebf69d0268 &signature=33e27a515f1478d00abcce577205e2f54e6d94f2
RESPONSE:
{ "jobId":"f39f2d5c-4bc6-4a15-90b5-00ebf69d0268", "results":[ {"url":"www.safestamper.com","status":"READY","certificateId":"160419-N3MBMN","certificateUrl":"https://web.safestamper.com/certificate/160419-N3MBMN"}, {"url":"www.safecreative.org","status":"INPROGRESS"} ] }