Authstate and Browse/status: Difference between pages
(Difference between pages)
api>Admin |
m (1 revision imported) |
||
Line 1: | Line 1: | ||
This operation | This operation returns the status of a web browsing certification. | ||
= URL = | = URL = | ||
<nowiki>https://www.safestamper.com/api/ | <nowiki>https://www.safestamper.com/api/browse/status</nowiki> | ||
= Parameters = | = Parameters = | ||
* '''sharedkey''': Your API client shared key | * '''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]] | * '''signature''': Parameters signature, as explained in [[Signature parameter]] | ||
Line 15: | Line 13: | ||
A JSON object with the following fields: | 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 = | = HTTP Errors = | ||
* '''403''' Forbidden: sharedkey or signature are not valid, or the | * '''403''' Forbidden: the sharedkey or signature are not valid, or the specified job does not belong to the API client | ||
* '''404''' Not found: the | * '''404''' Not found: the certification code is not correct. | ||
= Example = | = Example = | ||
Line 44: | Line 30: | ||
REQUEST: | REQUEST: | ||
<pre> | <pre> | ||
https://www.safestamper.com/api/ | https://www.safestamper.com/api/browse/status | ||
? | ?sharedkey=5hmpod0d2vx7fnh6ysxab3olz | ||
& | &code=161209-2DVSJZ | ||
&signature= | &signature=d7d141d923775616a12800ce52a5dc327919c29c | ||
</pre> | </pre> | ||
Line 53: | Line 39: | ||
<pre> | <pre> | ||
{ | { | ||
"code":"161209-2DVSJZ", | |||
"status":"FINISHED", | |||
"certificateUrl":"http://www.safestamper.com/certificate/161209-2DVSJZ" | |||
} | } | ||
</pre> | </pre> |
Latest revision as of 15: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" }