Newuser and Notification/delete: Difference between pages

From SafeStamper API documentation
(Difference between pages)
Jump to navigation Jump to search
m (1 revision imported)
 
m (1 revision imported)
 
Line 1: Line 1:
This operation creates a user in Safe Stamper, or creates an authorization for an existing Safe Stamper user.
This operation deletes a notification from Safe Stamper


= URL =
= URL =
<nowiki>https://www.safestamper.com/api/newuser</nowiki>
<nowiki>https://www.safestamper.com/api/notification/delete</nowiki>


= Parameters =
= Parameters =
* '''sharedkey''': Your API client shared key
* '''sharedkey''': Your API client shared key
* '''authkey''': Authkey of notification owner
* '''code''': Code of notification to delete
* '''signature''': Parameters signature, as explained in [[Signature parameter]]
* '''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)
<nowiki>*</nowiki> Required parameter
(?): At least provide one field (First or last name)


= Returns =
= Returns =


A JSON object with the authkey status, as returned in [[authstate]]:
HTTP 200 OK
 
* '''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 =
= HTTP Errors =


* '''400''' Bad Request: the countrycode or accounttype are not valid, or firstname and lastname are empty
* '''401''' Unauthorized: the authkey is not exist
* '''401''' Unauthorized: accounttype is sended but you are not a partner
* '''403''' Forbidden: the sharedkey or signature are not valid
* '''403''' Forbidden: the sharedkey is not valid, or the e-mail address already exists in Safe Stamper or Safe Creative
* '''404''' Not found: the notification does not exist


= Example =
= Example =
Line 54: Line 24:
REQUEST:
REQUEST:
<pre>
<pre>
https://www.safestamper.com/api/newuser
https://www.safestamper.com/api/notification/delete
?accounttype=premium
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec
&mail=apitest@safecreative.org
&code=170316-6K5D2Q
&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
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh
&signature=35e157d8539fd66ca385fabb8967d4e8f180056f
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77
</pre>
</pre>


RESPONSE (actual response has no line breaks or indentation):
RESPONSE:
<pre>
 
{
HTTP 200 OK
    "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"
}
</pre>

Latest revision as of 15:27, 17 October 2023

This operation deletes a notification from Safe Stamper

URL

https://www.safestamper.com/api/notification/delete

Parameters

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

Returns

HTTP 200 OK

HTTP Errors

  • 401 Unauthorized: the authkey is not exist
  • 403 Forbidden: the sharedkey or signature are not valid
  • 404 Not found: the notification does not exist

Example

REQUEST: 

https://www.safestamper.com/api/notification/delete
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec
&code=170316-6K5D2Q
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77

RESPONSE:

HTTP 200 OK

Retrieved from "https://wiki.safestamper.com/index.php?title=Newuser&oldid=63"