Status: Difference between revisions

From Safe Creative API
Jump to navigation Jump to search
w>Jguillo
w>Jguillo
No edit summary
Line 1: Line 1:
This operation returns the status of a certification job.
This operation returns the status of a certification job.


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


''<JOB_ID>'' is the job identifier returned by the [[stamp]] operation.
''<JOB_ID>'' is the job identifier returned by the [[stamp]] operation.


== Returns ==
= Returns =


A JSON object with the following fields:
A JSON object with the following fields:

Revision as of 09:52, 19 April 2016

This operation returns the status of a certification job.

URL

https://web.safestamper.com/api/status/<JOB_ID>

<JOB_ID> is the job identifier returned by the stamp operation.

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