Operators and Partners API: Difference between pages

From SafeStamper API documentation
(Difference between pages)
Jump to navigation Jump to search
api>Admin
 
api>Admin
No edit summary
 
Line 1: Line 1:
This operation lists the authorized operators that can use the subscription account
These operations are only available for designated partners, as they allow to create and modify other users' accounts.


= URL =
<nowiki>https://www.safestamper.com/api/operators</nowiki>


= Parameters =
= User authorization =
* '''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 =
To get an authorization key using the e-mail address and password of a user.


= Returns =
== API operations ==


A JSON list object with the following fields:
* [[authorize]]: Returns an authorization key linked to a user, using their e-mail address and password


* '''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 =
= User API Reference =


To create and link user accounts and activate professional services.


* '''401''' Unauthorized: the authkey is not valid
== API operations ==
* '''403''' Forbidden: the sharedkey is not valid
These components are only available for Partners API:


= Example =
* [[newuser]]: Create user in Safe Stamper. Also used to create authorization for an existing Safe Stamper user.
* [[modifyuser]]: Modify Safe Stamper user data.
* [[addcredits]]: Add certification credits or navigation credits to the authorization.
* [[newuserpack]]: Enable professional services linked to the authorization.
* [[deleteuserpack]]: Disable professional services linked to the authorization.
* [[users]]: Get users authorizated by api client


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


RESPONSE:


[
= Operators API Reference =
  {
 
    "accountType": "PREMIUM",
To manage operators (additional users) of subscription accounts. Operators are disabled when the subscription expire or is annulled.
    "authkey": "22644c3d-668c-492f-bef9-6ecf0fa8e495",
 
    "authorized": true,
== API operations ==
    "state": "ACTIVE",
These components are only available for Partners API:
    "availableCertificates": 50,
 
    "availableNavigations": 6,
* [[newoperator]]: Create an authorized operator for the subscription
    "availableTimestamps": 0,
* [[modifyoperator]]: Modify Safe Stamper operator data.
    "maxCertificateSize": 7500000,
* [[deleteoperator]]: Delete authorized operator.
    "maxCertificateSizeMb": 5,
* [[enableoperator]]: Enable access to authorized operator.
    "userCode": "1812100000748",
* [[disableoperator]]: Disable access to authorized operator.
    "userName": "Api Operator 1",
* [[operators]]: Get authorized operator list from the subscription
    "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"
  }
]

Revision as of 11:35, 22 September 2020

These operations are only available for designated partners, as they allow to create and modify other users' accounts.


User authorization

To get an authorization key using the e-mail address and password of a user.

API operations

  • authorize: Returns an authorization key linked to a user, using their e-mail address and password


User API Reference

To create and link user accounts and activate professional services.

API operations

These components are only available for Partners API:

  • newuser: Create user in Safe Stamper. Also used to create authorization for an existing Safe Stamper user.
  • modifyuser: Modify Safe Stamper user data.
  • addcredits: Add certification credits or navigation credits to the authorization.
  • newuserpack: Enable professional services linked to the authorization.
  • deleteuserpack: Disable professional services linked to the authorization.
  • users: Get users authorizated by api client


Operators API Reference

To manage operators (additional users) of subscription accounts. Operators are disabled when the subscription expire or is annulled.

API operations

These components are only available for Partners API: