Certificate/accesslevel and Certificate/get: Difference between pages

From SafeStamper API documentation
(Difference between pages)
Jump to navigation Jump to search
api>Admin
No edit summary
 
m (1 revision imported)
 
Line 1: Line 1:
This operation changes the access protection of a certificate.  
This operation downloads the certificate. No password is needed if the certificate is protected
 
There are three access protection modes for a certificate:
* '''PUBLIC''' The certificate can be downloaded by anyone who has its validation URL. This is the default, so that any party that receives a Safe Stamper certificate can verify its authenticity.
* '''PRIVATE''' Only the owner can download the certificate
* '''PASSWORD''' The validation URL asks for a password before downloading the certificate.
 
If you plan to give the certificate to a third party or use it in any legal proceeding, you should make it public or password-protected and provide the password along with the certificate, to allow the receiving party to verify the certificate authenticity.
 
The certificate owner can always download the certificate without a password. API applications can use [[certificate/get]] to download certificates from their users even if they are private or password-protected.


= URL =
= URL =
<nowiki>https://www.safestamper.com/api/certificate/accesslevel</nowiki>
<nowiki>https://web.safestamper.com/api/certificate/get</nowiki>


= Parameters =
= Parameters =
* '''sharedkey''': Your API client shared key
* '''sharedkey''': Your API client shared key
* '''authkey''': Authkey of certificate owner
* '''authkey''': Authkey of certificate owner
* '''code''': Code of certificate to set the password
* '''code''': Code of certificate to download
* '''level''': Access level for the certificate (''PUBLIC'', ''PRIVATE'' or ''PASSWORD'')
* '''password''': Certificate access password. Required for ''PASSWORD'' access level.
* '''signature''': Parameters signature, as explained in [[Signature parameter]]
* '''signature''': Parameters signature, as explained in [[Signature parameter]]


= Returns =
= Returns =


HTTP 200 OK
Returns the certificate file


= HTTP Errors =
= HTTP Errors =


* '''401''' Unauthorized: the authkey is not exist
* '''401''' Unauthorized: the authkey does not exist or is not authorized
* '''403''' Forbidden: the sharedkey or signature are not valid
* '''403''' Forbidden: the sharedkey or signature are not valid
* '''404''' Not found: the certificate does not exist
* '''404''' Not found: the certificate does not exist or does not belong to the user
* '''400''' Unrecognized access level or password not provided for PASSWORD level


= Example =
= Example =
Line 36: Line 24:
REQUEST:
REQUEST:
<pre>
<pre>
https://www.safestamper.com/api/certificate/accesslevel
https://web.safestamper.com/api/certificate/get
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec
&code=150730-U27FJH
&code=150121-6MY3TJ
&level=PASSWORD
&password=1234
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77
Line 47: Line 33:
RESPONSE:
RESPONSE:


HTTP 200 OK
Certificate file

Latest revision as of 15:27, 17 October 2023

This operation downloads the certificate. No password is needed if the certificate is protected

URL

https://web.safestamper.com/api/certificate/get

Parameters

  • sharedkey: Your API client shared key
  • authkey: Authkey of certificate owner
  • code: Code of certificate to download
  • signature: Parameters signature, as explained in Signature parameter

Returns

Returns the certificate file

HTTP Errors

  • 401 Unauthorized: the authkey does not exist or is not authorized
  • 403 Forbidden: the sharedkey or signature are not valid
  • 404 Not found: the certificate does not exist or does not belong to the user

Example

REQUEST:

https://web.safestamper.com/api/certificate/get
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec
&code=150121-6MY3TJ
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77

RESPONSE:

Certificate file