Modifyoperator: Difference between revisions

From SafeStamper API documentation
Jump to navigation Jump to search
api>Admin
Created page with "This operation modify Safe Stamper operator data. = URL = <nowiki>https://www.safestamper.com/api/modifyoperator</nowiki> = Parameters = * '''sharedkey''': Your API client s..."
 
m 1 revision imported
 
(No difference)

Latest revision as of 06:27, 17 October 2023

This operation modify Safe Stamper operator data.

URL

https://www.safestamper.com/api/modifyoperator

Parameters

  • sharedkey: Your API client shared key
  • authkey: Authorization key of operator
  • signature: Parameters signature, as explained in Signature parameter
  • mail: operator mail
  • firstName: first name of the operator
  • lastName: last name of the operator

Returns

A JSON object with the authkey status, as returned in authstate:

  • authkey: Authkey value
  • authorized: State of authkey (true|false).
  • state: State of Safe Stamper operator (ACTIVE|DISABLED)
  • userCode: Safe Stamper code of the authorizing operator.
  • userMail: Mail of the authorizing operator.
  • userName: Full name of the authorizing operator.
  • accountType: Account type of the main user (PREMIUM).
  • userType: User type of the authorizing operator (OPERATOR).
  • mainUserAuthkey: Authkey of main user for authorized operator.
  • availableCertificates: Available certification credits to use web static, mail, file and photo services.
  • availableNavigations: Available certification credits to use browsing session services.
  • availableTimestamps: Available timestamp credits to use tsa services.
  • maxCertificateSize: Máx size in bytes for certificates
  • maxCertificateSizeMb: Máx size in MB for certificates

HTTP Errors

  • 400 Bad Request: the countrycode or accounttype are not valid, or firstname and lastname are empty
  • 401 Unauthorized: accounttype is sended but you are not a partner
  • 403 Forbidden: the sharedkey is not valid, is mail exists in Safe Stamper

Example

REQUEST:

https://www.safestamper.com/api/modifyoperator
?authkey=22644c3d-668c-492f-bef9-6ecf0fa8e495
&mail=api.operator3@safecreative.org
&firstname=Api%2C+Operator
&lastname=3
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh
&signature=35e157d8539fd66ca385fabb8967d4e8f180056f

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

{
   "accountType": "PREMIUM",
   "authkey": "22644c3d-668c-492f-bef9-6ecf0fa8e495",
   "authorized": true,
   "state": "ACTIVE",
   "availableCertificates": 50,
   "availableNavigations": 6,
   "availableTimestamps": 0,
   "maxCertificateSize": 7500000,
   "maxCertificateSizeMb": 5,
   "userCode": "1812100000748",
   "userName": "Api Operator 3",
   "userMail": "api.operator3@safecreative.org",
   "userType": "OPERATOR",
   "mainUserAuthkey": "0021d81c-e4a5-4869-8384-2fd70cdb58ec"
 }