Status: Difference between revisions
Jump to navigation
Jump to search
w>Jguillo No edit summary |
w>Jguillo |
||
Line 20: | Line 20: | ||
*** ''ERROR'': The URL could not be certified | *** ''ERROR'': The URL could not be certified | ||
*** ''READY'': The URL certificate is ready for download | *** ''READY'': The URL certificate is ready for download | ||
** '''progress''': | ** '''progress''': Percentage of completion (for ''INPROGRESS'' status) | ||
** '''error''': Error description (for ''ERROR'' status) | ** '''error''': Error description (for ''ERROR'' status) | ||
** '''certificateId''': Certificate code (for ''READY'' status) | ** '''certificateId''': Certificate code (for ''READY'' status) |
Revision as of 13:16, 8 June 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
- progress: Percentage of completion (for INPROGRESS status)
- 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=c498d3e0-aedb-48fe-82d5-5dec4270318b &signature=5784ad59c9fb400451887a138bf8ad36cee729d2
RESPONSE (actual response has no line breaks or indentation):
{ "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} ] }