Newuser

From SafeStamper API documentation
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

This operation creates a user in Safe Stamper, or creates an authorization for an existing Safe Stamper user.

URL

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

Parameters

  • sharedkey: Your API client shared key
  • signature: Parameters signature, as explained in Signature parameter
  • mail*: user mail
  • firstName?: first name of the user
  • lastName?: last name of the user
  • address1: user address line 1
  • address2: user address line 2
  • zip: user address zip code
  • city: user address zip city
  • countrycode: user address country ISO code (Default 'ES')
  • language: user preferred language (es|en) Defaults to the language of the api client.
  • notifyActivity: (true|false) whether the user wants to receive an e-mail with a list of the e-mail certificates that have been generated with the user's account each day.

Partners may include this param:

  • accounttype: account type that will be enabled to the user (professional|corporate)

* Required parameter

(?): At least provide one field (First or last name)

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 user.
  • userMail: Mail of the user.
  • userName: Full name of the user.
  • accountType: Account type of the main user (BASIC|PREMIUM).
  • userType: User type of the user (INDIVIDUAL|ORGANIZATION).
  • 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, or the e-mail address already exists in Safe Stamper or Safe Creative

Example

REQUEST:

https://www.safestamper.com/api/newuser
?accounttype=premium
&mail=apitest@safecreative.org
&firstname=Api%2C+User
&lastname=Test
&address1=C%2F+Bari%2C+39%2C+2%C2%AA+Planta
&address2=%28Sede+Central%29
&zip=50197
&city=Zaragoza
&countrycode=ES
&language=es
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh
&signature=35e157d8539fd66ca385fabb8967d4e8f180056f

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

{
     "accountType":"PREMIUM",
     "authkey":"8639e12a-810c-4c51-8a62-c1b0fcf58bfd",
     "authorized":true,
     "availableCertificates":50,
     "availableNavigations":1,
     "availableTimestamps":10,
     "maxCertificateSize":"22500000"
     "maxCertificateSizemB":"15"
     "state":"ACTIVE",
     "userCode":"1612020000541",
     "userMail" : "apitest@safecreative.org",
     "userName":"Api User Test"
     "userType":"INDIVIDUAL"
}