Operators

From SafeStamper API documentation
Revision as of 07:32, 11 December 2018 by api>Admin (→‎Example)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This operation lists the authorized operators that can use the subscription account

URL

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

Parameters

  • sharedkey: Your API client shared key
  • authkey: Authkey of main user to list the authorized operators
  • signature: Parameters signature, as explained in Signature parameter

Returns

Returns

A JSON list object with the following fields:

  • authkey: Authkey value
  • authorized: State of authkey (true|false).
  • state: State of Safe Stamper user (ACTIVE|DISABLED)
  • userCode: Safe Stamper code of the authorizing user.
  • userMail: Mail of the authorizing user.
  • userName: Full name of the authorizing user.
  • accountType: Account type of the authorizing user (BASIC|PREMIUM).
  • userType: User type of the authorizing user (INDIVIDUAL|ORGANIZATION|OPERATOR).
  • mainUserAuthkey: Authkey of main user for authorized operators.
  • 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

  • 401 Unauthorized: the authkey is not valid
  • 403 Forbidden: the sharedkey is not valid

Example

REQUEST:

https://www.safestamper.com/api/operators
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh
&signature=f9e0222c2fcacbea7923552128a9d395d122e963

RESPONSE:

[

 {
   "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 1",
   "userMail": "api.operator@safecreative.org",
   "userType": "OPERATOR",
   "mainUserAuthkey": "0021d81c-e4a5-4869-8384-2fd70cdb58ec"
 },
 {
   "accountType": "PREMIUM",
   "authkey": "b25dde02-2376-4af0-bf0f-f8be600b0028",
   "authorized": true,
   "state": "DISABLED",
   "availableCertificates": 50,
   "availableNavigations": 6,
   "availableTimestamps": 0,
   "maxCertificateSize": 7500000,
   "maxCertificateSizeMb": 5,
   "userCode": "1812100000762",
   "userName": "Api Operator 2",
   "userMail": "api.operator2@safecreative.org",
   "userType": "OPERATOR",
   "mainUserAuthkey": "0021d81c-e4a5-4869-8384-2fd70cdb58ec"
 }

]