Browse/status: Difference between revisions

From SafeStamper API documentation
Jump to navigation Jump to search
api>Admin
Created page with "This operation returns the status of a web browsing certification. = URL = <nowiki>https://www.safestamper.com/api/browse/status</nowiki> = Parameters = * '''sharedkey''': Y..."
 
m 1 revision imported
 
(No difference)

Latest revision as of 06:27, 17 October 2023

This operation returns the status of a web browsing certification.

URL

https://www.safestamper.com/api/browse/status

Parameters

  • sharedkey: Your API client shared key
  • code: The certification code received in the browse/stamp bringback URL
  • signature: Parameters signature, as explained in Signature parameter

Returns

A JSON object with the following fields:

  • code: The certification code
  • status: Certification status
    • RUNNING: The browsing session is still running
    • PENDING_CERTIFICATION: The browsing session was completed, but the certification is being processed
    • FINISHED: The certification has been completed and the certificate PDF is ready for download
    • CANCELLED: The user cancelled the browsing session
  • certificateUrl: Certificate download URL (for FINISHED 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 certification code is not correct.

Example

REQUEST:

https://www.safestamper.com/api/browse/status
?sharedkey=5hmpod0d2vx7fnh6ysxab3olz
&code=161209-2DVSJZ
&signature=d7d141d923775616a12800ce52a5dc327919c29c

RESPONSE (actual response has no line breaks or indentation):

{
   "code":"161209-2DVSJZ",
   "status":"FINISHED",
   "certificateUrl":"http://www.safestamper.com/certificate/161209-2DVSJZ"
}