Difference between revisions of "Browse/stamp"

From Safe Stamper API
Jump to: navigation, search
(Created page with "Launches a certified web browsing session. This operation directly redirects to the session launching page, so it is not a server-to-server API operation. You must build the ...")
 
 
(2 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
This operation directly redirects to the session launching page, so it is not a server-to-server API operation.
 
This operation directly redirects to the session launching page, so it is not a server-to-server API operation.
 
You must build the request URL and redirect the user to that URL in a web browser.
 
You must build the request URL and redirect the user to that URL in a web browser.
 +
 +
Once the user ends the browsing session, the user will be redirected to the specified bringback URL, that will receive the certificate code as a parameter. It can take some time to process de browsing session and build the certificate, you can call [[browse/status]] to check the status of a web browsing certificate.
  
 
= URL =
 
= URL =
Line 14: Line 16:
 
** ''web_snapshots'': Browsing session with screen snapshots
 
** ''web_snapshots'': Browsing session with screen snapshots
 
** ''web_video'': Browsing session with full audio/video recording
 
** ''web_video'': Browsing session with full audio/video recording
* '''bringback''': URL where the user will be redirected after the browsing session is finished. See [[Web browsing API bringbacks]]
+
* '''bringback''': URL where the user will be redirected after the browsing session is finished. See the [[#Bringback URL | Bringback URL]] section for details.
 
* '''signature''': Parameters signature, as explained in [[Signature parameter]]
 
* '''signature''': Parameters signature, as explained in [[Signature parameter]]
  
Line 41: Line 43:
 
&signature=5edc8b14a1e0937238cace104a42e8a1096e05c1
 
&signature=5edc8b14a1e0937238cace104a42e8a1096e05c1
 
</pre>
 
</pre>
 +
 +
= Bringback URL =
 +
 +
Once the browsing session is finished, the user will be redirected to the specified bringback URL.
 +
 +
The following query string parameters will be appended to the bringback URL:
 +
 +
* '''code''' Certificate code. You can use this code to check if the certificate has been completely processed calling [[browse/status]]
 +
* '''cancel''' If this parameter is present with a ''true'' value, it indicates that the user cancelled the browsing session.

Latest revision as of 08:11, 15 December 2016

Launches a certified web browsing session.

This operation directly redirects to the session launching page, so it is not a server-to-server API operation. You must build the request URL and redirect the user to that URL in a web browser.

Once the user ends the browsing session, the user will be redirected to the specified bringback URL, that will receive the certificate code as a parameter. It can take some time to process de browsing session and build the certificate, you can call browse/status to check the status of a web browsing certificate.

URL

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

Parameters

  • sharedkey: Your API client shared key
  • authkey: Authorization key
  • url: The URL where the browsing session should start
  • type: Type of browsing session
    • web_snapshots: Browsing session with screen snapshots
    • web_video: Browsing session with full audio/video recording
  • bringback: URL where the user will be redirected after the browsing session is finished. See the Bringback URL section for details.
  • signature: Parameters signature, as explained in Signature parameter

Returns

An HTML page that launches the browsing session

HTTP Errors

  • 403 Forbidden, the sharedkey or signature are not valid
  • 401 Unauthorized, the authkey is not valid
  • 429 Your Safe Stamper user has no navigation credits available
  • 430 Your Safe Stamper user has no storage space available

Example

This example launches a browsing session starting at https://www.safestamper.com and redirects the user to https://www.example.com/bringback on completion

REQUEST:

https://www.safestamper.com/api/browse/stamp
?sharedkey=5hmpod0d2vx7fnh6ysxab3olz
&authkey=115a88b6-7420-4837-b6e5-fd231b02b1cd
&url=https%3A%2F%2Fwww.safestamper.com
&type=web_snapshots
&bringback=https%3A%2F%2Fwww.example.com%2Fbringback
&signature=5edc8b14a1e0937238cace104a42e8a1096e05c1

Bringback URL

Once the browsing session is finished, the user will be redirected to the specified bringback URL.

The following query string parameters will be appended to the bringback URL:

  • code Certificate code. You can use this code to check if the certificate has been completely processed calling browse/status
  • cancel If this parameter is present with a true value, it indicates that the user cancelled the browsing session.