https://wiki.safestamper.com/api.php?action=feedcontributions&feedformat=atom&user=AdminwikiSafeStamper API documentation - User contributions [en]2026-05-05T01:57:11ZUser contributionsMediaWiki 1.43.1https://wiki.safestamper.com/index.php?title=Web/stamp&diff=116Web/stamp2026-04-24T06:47:56Z<p>Adminwiki: /* Parameters */</p>
<hr />
<div>Launches a static web page certification job<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/web/stamp</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authorization key<br />
* '''url''N''''': The URLs you want to certificate. Multiple URLs can be specified as url1, url2, etc.<br />
* '''withUrls''': Include in the certificate a listing with all URLs accessed during page load (optional, defaults to false)<br />
* '''withHeaders''': Include in the certificate a listing with all headers received from each URL. Requires withUrls=true. (optional, defaults to false)<br />
* '''acceptCookies''': Accept cookies automatically when accessing the URL for certification (optional, defaults to false)<br />
* '''proxy''': Choose location proxy for capture (optional, defaults to none)<br />
** ''none'': No proxy (capture from Ireland)<br />
** ''ES'': Launch capture from Spain<br />
** ''DE'': Launch capture from Germany<br />
** ''US'': Launch capture from USA<br />
* '''callback''': Callback URL to call when the job is finished (optional). See [[Web API callbacks]]<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
A job identifier that can be used to check the status of the operation with [[web/status]].<br />
<br />
The identifier is returned between double quotes, in order to be a valid JSON value.<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden, the sharedkey or signature are not valid<br />
* '''401''' Unauthorized, the authkey is not valid <br />
* '''429''' Your Safe Stamper user has no certification credits available<br />
* '''430''' Your Safe Stamper user has no storage space available<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/web/stamp<br />
?sharedkey=5hmpod0d2vx7fnh6ysxab3olz<br />
&url1=http%3A%2F%2Fwww.safestamper.com<br />
&url2=NON-VALID-URL<br />
&url3=http%3A%2F%2Fwww.safecreative.org<br />
&signature=aa052389e2d9d508dbb8fc0ef9cb72abc12c7109<br />
</pre><br />
<br />
RESPONSE:<br />
<pre><br />
"c498d3e0-aedb-48fe-82d5-5dec4270318b"<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Certificates&diff=115Certificates2026-03-10T08:22:09Z<p>Adminwiki: /* Returns */</p>
<hr />
<div>This operation lists the certificates of the authorizing user.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/certificates</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authorization key<br />
* '''type''': Type of certificate to search <br />
** ''web_static'' Static web pages<br />
** ''web_snapshots'' Web browsing sessions with snapshots<br />
** ''web_video'' Web browsing sessions with video<br />
** ''web'' Web certificates, includes ''web_static'', ''web_snapshots'' and ''web_video'' certificates<br />
** ''mail'' E-mail certificates<br />
** ''photo'' Geo-located photographs<br />
** ''video'' Geo-located video recordings<br />
** ''audio'' Geo-located audio recordings<br />
** ''photo_video'' Mobile app certificates (includes ''photo'', ''video'' and ''audio'' certificates)<br />
** ''file'' Files<br />
** ''noti'' Notification certificates<br />
** ''signature'' Signed documents<br />
* '''fromDate''': Return certificates generated from this date on (optional, format yyyy-MM-dd)<br />
* '''toDate''': Return certificates generated up to this date (optional, format yyyy-MM-dd)<br />
* '''filter''': Text for searching certificates (optional)<br />
* '''page''': Page number to return (optional, defaults to 1)<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''pageSize''': Maximum number of certificates per page<br />
* '''count''': Total number of certificates<br />
* '''pageTotal''': Total number of pages <br />
* '''list''': array of JSON with the certificates data<br />
** '''entryDate''': Date of certificate<br />
** '''code''': Certificate code<br />
** '''url''': Public URL for certificate download<br />
** '''thumbnailUrl''': URL of thumbnail of certificate (optional, just for web and photo certificates)<br />
** '''properties''': JSON with the properties of the certificate<br />
*** Web certificates<br />
**** '''url''': URL that was certified <br />
*** Mail certificates<br />
**** '''toAddresses''': E-mail destinataries<br />
**** '''subject''': Subject of e-mail<br />
*** Photo certificates<br />
**** '''latitude''': Latitude where the photo was taken<br />
**** '''longitude''': Longitude where the photo was taken<br />
**** '''accuracy''': Accuracy of geographic location, in meters<br />
**** '''address''': Human-readable photo location<br />
**** '''photoUrl''': Temporary URL for downloading the original photo (valid for 1 hour)<br />
*** File certificates<br />
**** '''filename''': File name <br />
**** '''size''': Size of file<br />
**** '''md5''': MD5 hash of file<br />
**** '''sha1''': SHA1 hash of file<br />
**** '''sha256''': SHA256 hash of file<br />
**** '''sha512''': SHA512 hash of file<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
* '''401''' Unauthorized: authkey is not valid or not authorized<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/certificates<br />
?authkey=0dbb406d-cc0c-4ef8-ae80-971ed108c2f9<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&type=web<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"pageSize":50,<br />
"count":1, <br />
"pageTotal":1,<br />
"list":[<br />
{<br />
"entryDate":"2016-11-11T12:59:36Z",<br />
"code":"161111-8CM65B",<br />
"url":"http://dev.safestamper.com:9001/certificate/161111-8CM65B",<br />
"thumbnailUrl":"https://pagestamper-dev.s3.amazonaws.com/16/11/11/161111-8CM65B.png?AWSAccessKeyId\u003dAKIAI2GFJVQOFPVV5SZA\u0026Expires\u003d1480695450\u0026Signature\u003dL7TBOPa6gKVS5OTGASfq68XMxGk%3D",<br />
"properties":{"url":"https://informaticaglobaldariomo.blogspot.com.es/2016/08/startup-manager-una-aplicacion-android.html"}<br />
}<br />
]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Certificates&diff=114Certificates2026-01-16T08:08:31Z<p>Adminwiki: /* Parameters */</p>
<hr />
<div>This operation lists the certificates of the authorizing user.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/certificates</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authorization key<br />
* '''type''': Type of certificate to search <br />
** ''web_static'' Static web pages<br />
** ''web_snapshots'' Web browsing sessions with snapshots<br />
** ''web_video'' Web browsing sessions with video<br />
** ''web'' Web certificates, includes ''web_static'', ''web_snapshots'' and ''web_video'' certificates<br />
** ''mail'' E-mail certificates<br />
** ''photo'' Geo-located photographs<br />
** ''video'' Geo-located video recordings<br />
** ''audio'' Geo-located audio recordings<br />
** ''photo_video'' Mobile app certificates (includes ''photo'', ''video'' and ''audio'' certificates)<br />
** ''file'' Files<br />
** ''noti'' Notification certificates<br />
** ''signature'' Signed documents<br />
* '''fromDate''': Return certificates generated from this date on (optional, format yyyy-MM-dd)<br />
* '''toDate''': Return certificates generated up to this date (optional, format yyyy-MM-dd)<br />
* '''filter''': Text for searching certificates (optional)<br />
* '''page''': Page number to return (optional, defaults to 1)<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''pageSize''': Maximum number of certificates per page<br />
* '''count''': Total number of certificates<br />
* '''pageTotal''': Total number of pages <br />
* '''list''': array of JSON with the certificates data<br />
** '''entryDate''': Date of certificate<br />
** '''code''': Certificate code<br />
** '''url''': Public URL for certificate download<br />
** '''thumbnailUrl''': URL of thumbnail of certificate (optional, just for web and photo certificates)<br />
** '''properties''': JSON with the properties of the certificate<br />
*** Web certificates<br />
**** '''url''': URL that was certified <br />
*** Mail certificates<br />
**** '''toAddresses''': E-mail destinataries<br />
**** '''subject''': Subject of e-mail<br />
*** Photo certificates<br />
**** '''latitude''': Latitude where the photo was taken<br />
**** '''longitude''': Longitude where the photo was taken<br />
**** '''accuracy''': Accuracy of geographic location, in meters<br />
**** '''address''': Human-readable photo location<br />
*** File certificates<br />
**** '''filename''': File name <br />
**** '''size''': Size of file<br />
**** '''md5''': MD5 hash of file<br />
**** '''sha1''': SHA1 hash of file<br />
**** '''sha256''': SHA256 hash of file<br />
**** '''sha512''': SHA512 hash of file<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
* '''401''' Unauthorized: authkey is not valid or not authorized<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/certificates<br />
?authkey=0dbb406d-cc0c-4ef8-ae80-971ed108c2f9<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&type=web<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"pageSize":50,<br />
"count":1, <br />
"pageTotal":1,<br />
"list":[<br />
{<br />
"entryDate":"2016-11-11T12:59:36Z",<br />
"code":"161111-8CM65B",<br />
"url":"http://dev.safestamper.com:9001/certificate/161111-8CM65B",<br />
"thumbnailUrl":"https://pagestamper-dev.s3.amazonaws.com/16/11/11/161111-8CM65B.png?AWSAccessKeyId\u003dAKIAI2GFJVQOFPVV5SZA\u0026Expires\u003d1480695450\u0026Signature\u003dL7TBOPa6gKVS5OTGASfq68XMxGk%3D",<br />
"properties":{"url":"https://informaticaglobaldariomo.blogspot.com.es/2016/08/startup-manager-una-aplicacion-android.html"}<br />
}<br />
]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Notification/get&diff=113Notification/get2025-05-20T11:34:12Z<p>Adminwiki: /* Returns */</p>
<hr />
<div>This operation get info of a notification. <br />
<br />
= URL =<br />
<nowiki>https://web.safestamper.com/api/notification/get</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of notification owner<br />
* '''code''': Code of notification to get info<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''entryDate''': Date of notification<br />
* '''code''': Notification code<br />
* '''subject''': Subject of notification<br />
* '''body''': Body content of notification<br />
* '''recipientType''': Send type of the notification<br />
* '''recipientMail''': E-mail address of the notification recipient<br />
* '''recipientPhone''': Phone of the notification recipient<br />
* '''recipientName''': Name of the notification recipient<br />
* '''attachmentName''': Attachment name of notification<br />
* '''state''': State of notification<br />
** ''PENDING'' The notification is pending to read<br />
** ''READ'' The notificaction has been read<br />
** ''ANSWERED'' The notification has been answered<br />
* '''certificates''': List of certificates generated from this notification<br />
** '''entryDate''': Date of certificate<br />
** '''code''': Certificate code<br />
** '''url''': Public URL for certificate download<br />
* '''readings''': List of readings of this notification<br />
** '''ip''': IP from which the notification was read<br />
** '''country''': Country code from which the notification was read<br />
** '''city''': City from which the notification was read<br />
** '''date''': Date read<br />
** '''downloadAttachment''': Indicates if the attachment was downloaded<br />
** '''answer''' Recipient's answer to the notification<br />
<br />
= HTTP Errors =<br />
<br />
* '''401''' Unauthorized: the authkey does not exist or is not authorized<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
* '''404''' Not found: the notification does not exist or does not belong to the user<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://web.safestamper.com/api/notification/get<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&code=170316-6K5D2Q<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"entryDate": "2017-03-16T12:59:08Z",<br />
"code": "170316-6K5D2Q",<br />
"state": "READED",<br />
"subject": "Example notification",<br />
"body": "Notification text",<br />
"recipientType": "EMAIL",<br />
"recipientMail": "jdoe@example.com",<br />
"recipientPhone": "",<br />
"recipientName": "John Doe",<br />
"certificates": [<br />
{<br />
"entryDate": "2017-03-16T12:59:44Z",<br />
"code": "170316-WMZMFS",<br />
"url": "http:\/\/dev.safestamper.com:9001\/certificate\/170316-WMZMFS",<br />
}],<br />
"readings": [<br />
{<br />
"ip": "127.0.0.1",<br />
"date": "2017-03-16T12:59:34Z",<br />
"downloadAttachment": "false"<br />
}]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Notification/send&diff=112Notification/send2025-05-20T10:59:20Z<p>Adminwiki: /* Parameters */</p>
<hr />
<div>This operation sends a notification to destinataries<br />
<br />
= URL =<br />
<nowiki>https://web.safestamper.com/api/notification/send</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of notification owner<br />
* '''recipientTypeN''': (multivalue) Send type of notification. <br />
* '''recipientNameN''': (multivalue) Name of recipient of notification<br />
* '''recipientMailN''': (multivalue) Mail of recipient of notification. In recipientTypeN equals EMAIL<br />
* '''recipientSmsN''': (multivalue) Phone of recipient of notification. In recipientTypeN equals SMS<br />
* '''subject''': Subject of the notification<br />
* '''body''': text of the notification<br />
* '''attachment''': Attach file of notification<br />
* '''answerable''': (true|false) Whether the recipients can register their answer to the notification<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
** '''NOTE''': When calculating the signature use the attachment file name as the value of file parameter<br />
<br />
= Returns =<br />
<br />
A JSON object with list of following fields:<br />
<br />
* '''entryDate''': Date of notification<br />
* '''code''': Notification code<br />
* '''uuid''': Notification uuid<br />
* '''subject''': Subject of notification<br />
* '''body''': Body content of notification<br />
* '''recipientType''': Send type of the notification<br />
* '''recipientMail''': E-mail address of the notification recipient<br />
* '''recipientPhone''': Phone of the notification recipient<br />
* '''recipientName''': Name of the notification recipient<br />
* '''attachmentName''': Attachment name of notification<br />
* '''state''': State of notification<br />
** ''PENDING'' The notification is pending to read<br />
** ''READ'' The notificaction has been read<br />
<br />
= HTTP Errors =<br />
<br />
* '''401''' Unauthorized: the authkey does not exist or is not authorized<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://web.safestamper.com/api/notification/send<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&recipientType1=EMAIL<br />
&recipientMail1=sample@mail.com<br />
&recipientName1=Sample<br />
&subject=Example+notification<br />
&body=Notification+text<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
[<br />
{<br />
"entryDate": "2017-03-16T12:59:08Z",<br />
"code": "170316-6K5D2Q",<br />
"uuid": "a59e091e-2338-4037-b383-91235bc0f9f3",<br />
"state": "PENDING",<br />
"subject": "Example notification",<br />
"body": "Notification text"<br />
"recipientType": "EMAIL",<br />
"recipientMail": "sample@mail.com",<br />
"recipientName": "Sample"<br />
"recipientPhone": ""<br />
}<br />
]<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Signature/status&diff=111Signature/status2024-09-18T08:14:05Z<p>Adminwiki: /* Returns */</p>
<hr />
<div>Returns the status of a document signature.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/signature/status</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authorization key, if needed<br />
* '''code''': Document code, returned by [[signature/sign]]<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''code''': Document code<br />
* '''title''': Document title<br />
* '''senderName''': Sender name<br />
* '''senderEmail''': Sender e-mail address<br />
* '''entryDate''': Date of upload<br />
* '''state''': Document state<br />
** '''PENDING''': The document doesn't have all its signatures<br />
** '''SIGNED''': The document has all its signatures and it has generated a signing certificate<br />
* '''certificateCode''': Code of the signature certificate, if it has already been generated (for SIGNED documents)<br />
* '''certificateUrl''': Direct download URL for the signature certificate, if it has already been generated (for SIGNED documents)<br />
** This URL can be used to download the certificate internally, but should not be provided to the end user.<br />
** If the document status is queried when the document has just been signed by its last signer, it may be in SIGNED state, but the certificate can still be in process and may not be available yet for download.<br />
* '''certificateValidationUrl''': Validation URL of the signature certificate, if it has already been generated (for SIGNED documents)<br />
** This URL is for end users to access the signature certificate.<br />
* '''password''': Generated access password for downloading the signature certificate (for SIGNED documents). <br />
** End users will need to know this password to get the document from certificateValidationUrl.<br />
* '''signatures''': The list of signatures<br />
** '''signerName''': Signer name<br />
** '''signerEmail''': Signer e-mail address<br />
** '''state''': Signature state<br />
*** '''PENDING''': The signer has not answered yet<br />
*** '''SIGNED''': The signer has signed the document<br />
** '''signerIP''': IP address from which the document was signed<br />
** '''signatureDate''': Date of signature<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden, the sharedkey or parameter signature are not valid<br />
* '''401''' Unauthorized, the authkey is not valid <br />
* '''404''' Document code not found<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/signature/sign<br />
?sharedkey=5hmpod0d2vx7fnh6ysxab3olz<br />
&code=b508e6e9-e5f6-4bb5-beef-c89bf6b50764<br />
&signature=6e83ffc1db2ea262c71426f2660882539d40ec60<br />
</pre><br />
<br />
RESPONSE:<br />
<pre><br />
{<br />
"code":"b508e6e9-e5f6-4bb5-beef-c89bf6b50764",<br />
"title":"Test Document",<br />
"senderName":"John Doe",<br />
"senderEmail":"john@example.com",<br />
"state":"PENDING",<br />
"entryDate":"2019-07-29T09:18:46Z",<br />
"signatures":[<br />
{<br />
"signerName":"Anne Example",<br />
"signerEmail":"anne@example.com",<br />
"signerIP":"127.0.0.1",<br />
"state":"SIGNED",<br />
"signatureDate":"2019-07-29T09:32:41Z"<br />
},<br />
{<br />
"signerName":"Bernie Beans",<br />
"signerEmail":"bernie@example.com",<br />
"state":"PENDING"<br />
}<br />
]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Signature/status&diff=110Signature/status2024-09-18T08:13:41Z<p>Adminwiki: /* Returns */</p>
<hr />
<div>Returns the status of a document signature.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/signature/status</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authorization key, if needed<br />
* '''code''': Document code, returned by [[signature/sign]]<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''code''': Document code<br />
* '''title''': Document title<br />
* '''senderName''': Sender name<br />
* '''senderEmail''': Sender e-mail address<br />
* '''entryDate''': Date of upload<br />
* '''state''': Document state<br />
** '''PENDING''': The document doesn't have all its signatures<br />
** '''SIGNED''': The document has all its signatures and it has generated a signing certificate<br />
* '''certificateCode''': Code of the signature certificate, if it has already been generated (for SIGNED documents)<br />
* '''certificateUrl''': Direct download URL for the signature certificate, if it has already been generated (for SIGNED documents)<br />
** This URL can be used to download the certificate internally, but should not be provided to the end user.<br />
** If the document status is queried when the document has just been signed by its last signer, it may be in SIGNED state, but the certificate can still be in process and may not be available yet for download.<br />
* '''certificateValidationUrl''': Validation URL of the signature certificate, if it has already been generated (for SIGNED documents)<br />
** This URL is for end users to access the signature certificate.<br />
* '''password''': Access password for downloading the signature certificate (for SIGNED documents). <br />
** End users will need to know this password to get the document from certificateValidationUrl.<br />
* '''signatures''': The list of signatures<br />
** '''signerName''': Signer name<br />
** '''signerEmail''': Signer e-mail address<br />
** '''state''': Signature state<br />
*** '''PENDING''': The signer has not answered yet<br />
*** '''SIGNED''': The signer has signed the document<br />
** '''signerIP''': IP address from which the document was signed<br />
** '''signatureDate''': Date of signature<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden, the sharedkey or parameter signature are not valid<br />
* '''401''' Unauthorized, the authkey is not valid <br />
* '''404''' Document code not found<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/signature/sign<br />
?sharedkey=5hmpod0d2vx7fnh6ysxab3olz<br />
&code=b508e6e9-e5f6-4bb5-beef-c89bf6b50764<br />
&signature=6e83ffc1db2ea262c71426f2660882539d40ec60<br />
</pre><br />
<br />
RESPONSE:<br />
<pre><br />
{<br />
"code":"b508e6e9-e5f6-4bb5-beef-c89bf6b50764",<br />
"title":"Test Document",<br />
"senderName":"John Doe",<br />
"senderEmail":"john@example.com",<br />
"state":"PENDING",<br />
"entryDate":"2019-07-29T09:18:46Z",<br />
"signatures":[<br />
{<br />
"signerName":"Anne Example",<br />
"signerEmail":"anne@example.com",<br />
"signerIP":"127.0.0.1",<br />
"state":"SIGNED",<br />
"signatureDate":"2019-07-29T09:32:41Z"<br />
},<br />
{<br />
"signerName":"Bernie Beans",<br />
"signerEmail":"bernie@example.com",<br />
"state":"PENDING"<br />
}<br />
]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Signature/status&diff=109Signature/status2024-09-18T08:11:52Z<p>Adminwiki: /* Returns */</p>
<hr />
<div>Returns the status of a document signature.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/signature/status</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authorization key, if needed<br />
* '''code''': Document code, returned by [[signature/sign]]<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''code''': Document code<br />
* '''title''': Document title<br />
* '''senderName''': Sender name<br />
* '''senderEmail''': Sender e-mail address<br />
* '''entryDate''': Date of upload<br />
* '''state''': Document state<br />
** '''PENDING''': The document doesn't have all its signatures<br />
** '''SIGNED''': The document has all its signatures and it has generated a signing certificate<br />
* '''certificateCode''': Code of the signature certificate, if it has already been generated (for SIGNED documents)<br />
* '''certificateUrl''': Direct download URL for the signature certificate, if it has already been generated (for SIGNED documents)<br />
** This URL should be used only to download the certificate internally and should not be provided to the end user.<br />
** If the document status is queried when the document has just been signed by its last signer, it may be in SIGNED state, but the certificate can still be in process and may not be available yet for download.<br />
* '''certificateValidationUrl''': Validation URL of the signature certificate, if it has already been generated (for SIGNED documents)<br />
** This URL is for end users to access the signature certificate.<br />
* '''password''': Access password for downloading the signature certificate (for SIGNED documents). <br />
** End users will need to know this password to get the document from certificateValidationUrl.<br />
* '''signatures''': The list of signatures<br />
** '''signerName''': Signer name<br />
** '''signerEmail''': Signer e-mail address<br />
** '''state''': Signature state<br />
*** '''PENDING''': The signer has not answered yet<br />
*** '''SIGNED''': The signer has signed the document<br />
** '''signerIP''': IP address from which the document was signed<br />
** '''signatureDate''': Date of signature<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden, the sharedkey or parameter signature are not valid<br />
* '''401''' Unauthorized, the authkey is not valid <br />
* '''404''' Document code not found<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/signature/sign<br />
?sharedkey=5hmpod0d2vx7fnh6ysxab3olz<br />
&code=b508e6e9-e5f6-4bb5-beef-c89bf6b50764<br />
&signature=6e83ffc1db2ea262c71426f2660882539d40ec60<br />
</pre><br />
<br />
RESPONSE:<br />
<pre><br />
{<br />
"code":"b508e6e9-e5f6-4bb5-beef-c89bf6b50764",<br />
"title":"Test Document",<br />
"senderName":"John Doe",<br />
"senderEmail":"john@example.com",<br />
"state":"PENDING",<br />
"entryDate":"2019-07-29T09:18:46Z",<br />
"signatures":[<br />
{<br />
"signerName":"Anne Example",<br />
"signerEmail":"anne@example.com",<br />
"signerIP":"127.0.0.1",<br />
"state":"SIGNED",<br />
"signatureDate":"2019-07-29T09:32:41Z"<br />
},<br />
{<br />
"signerName":"Bernie Beans",<br />
"signerEmail":"bernie@example.com",<br />
"state":"PENDING"<br />
}<br />
]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Signature/status&diff=108Signature/status2024-09-18T08:10:53Z<p>Adminwiki: /* Returns */</p>
<hr />
<div>Returns the status of a document signature.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/signature/status</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authorization key, if needed<br />
* '''code''': Document code, returned by [[signature/sign]]<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''code''': Document code<br />
* '''title''': Document title<br />
* '''senderName''': Sender name<br />
* '''senderEmail''': Sender e-mail address<br />
* '''entryDate''': Date of upload<br />
* '''state''': Document state<br />
** '''PENDING''': The document doesn't have all its signatures<br />
** '''SIGNED''': The document has all its signatures and it has generated a signing certificate<br />
* '''certificateCode''': Code of the signature certificate, if it has already been generated (for SIGNED documents)<br />
* '''certificateUrl''': Direct download URL for the signature certificate, if it has already been generated (for SIGNED documents)<br />
** This URL should be used only to download the certificate internally and should not be provided to the end user.<br />
** If the document status is queried when the document has just been signed by its last signer, it may be in SIGNED state, but the certificate can still be in process and may not be available yet for download.<br />
* '''certificateValidationUrl''': Validation URL of the signature certificate, if it has already been generated (for SIGNED documents)<br />
** This URL is for end users to access the signature certificate.<br />
* '''password''': Access password for downloading the signature certificate. End users will need to know this password to access the certificateValidationUrl.<br />
* '''signatures''': The list of signatures<br />
** '''signerName''': Signer name<br />
** '''signerEmail''': Signer e-mail address<br />
** '''state''': Signature state<br />
*** '''PENDING''': The signer has not answered yet<br />
*** '''SIGNED''': The signer has signed the document<br />
** '''signerIP''': IP address from which the document was signed<br />
** '''signatureDate''': Date of signature<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden, the sharedkey or parameter signature are not valid<br />
* '''401''' Unauthorized, the authkey is not valid <br />
* '''404''' Document code not found<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/signature/sign<br />
?sharedkey=5hmpod0d2vx7fnh6ysxab3olz<br />
&code=b508e6e9-e5f6-4bb5-beef-c89bf6b50764<br />
&signature=6e83ffc1db2ea262c71426f2660882539d40ec60<br />
</pre><br />
<br />
RESPONSE:<br />
<pre><br />
{<br />
"code":"b508e6e9-e5f6-4bb5-beef-c89bf6b50764",<br />
"title":"Test Document",<br />
"senderName":"John Doe",<br />
"senderEmail":"john@example.com",<br />
"state":"PENDING",<br />
"entryDate":"2019-07-29T09:18:46Z",<br />
"signatures":[<br />
{<br />
"signerName":"Anne Example",<br />
"signerEmail":"anne@example.com",<br />
"signerIP":"127.0.0.1",<br />
"state":"SIGNED",<br />
"signatureDate":"2019-07-29T09:32:41Z"<br />
},<br />
{<br />
"signerName":"Bernie Beans",<br />
"signerEmail":"bernie@example.com",<br />
"state":"PENDING"<br />
}<br />
]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=MediaWiki:Sidebar&diff=107MediaWiki:Sidebar2023-10-17T11:39:56Z<p>Adminwiki: Created page with "* Safe Stamper API ** API Overview|API Overview ** API Reference|API Reference"</p>
<hr />
<div>* Safe Stamper API<br />
** API Overview|API Overview<br />
** API Reference|API Reference</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Main_Page&diff=106Main Page2023-10-17T11:28:30Z<p>Adminwiki: </p>
<hr />
<div>=== Welcome to Safe Stamper Wiki!===<br />
<br />
Here you can find documentation about the Safe Stamper API.<br />
<br />
<br />
<br />
= Safe Stamper API =<br />
* [[API Overview]]: First steps and basic concepts for using Safe Creative API<br />
* [[API Reference]]: Reference documentation for each component in the Safe Creative API<br />
<br />
To access the use of the Safe Stamper API request a quote [https://www.safestamper.com/commercial here], and subject to the following [http://www.safecreative.org/legal-api terms of service].</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Web_API_callbacks&diff=105Web API callbacks2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>When starting a certification job with [[web/stamp]] you can provide a callback URL.<br />
<br />
Once the certification job is finished, the callback URL will receive a POST call with the same JSON object as returned in the [[web/status]] operation.<br />
<br />
To authenticate the callback, the JSON object HMAC-SHA1 will be calculated using the API client private key and will be provided as a query string '''signature''' parameter.<br />
<br />
NOTE: These callbacks are independent from the [[API Overview#API callbacks | API callbacks]] sent to the callback URL associated to your API client.<br />
<br />
== Example ==<br />
<br />
Line breaks have been included in this example content for legibility, but actual callbacks include the whole JSON in a single line.<br />
<br />
<pre><br />
POST /stamper-callback?signature=743ae4504eb41cbfe2d2e72dac76a27613333a53 HTTP/1.1<br />
Host: example.com<br />
Content-Type: application/json<br />
Content-Length: 377<br />
<br />
{<br />
"jobId":"c498d3e0-aedb-48fe-82d5-5dec4270318b",<br />
"results":[<br />
{"url":"http://www.safestamper.com","status":"READY","certificateId":"160419-BQS763","certificateUrl":"https://arena-web.safestamper.com/certificate/160419-BQS763"},<br />
{"url":"NON-VALID-URL","status":"ERROR","error":"bad-url"},<br />
{"url":"http://www.safecreative.org","status":"READY","certificateId":"160419-2LYD3K","certificateUrl":"https://arena-web.safestamper.com/certificate/160419-2LYD3K"}<br />
]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Web/status&diff=103Web/status2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation returns the status of a certification job.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/web/status</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''jobId''': The job identifier returned by the [[stamp]] operation<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''jobId''': Job identifier<br />
* '''results''': Array of JSON objects with the status of each URL included in the certification job<br />
** '''url''': URL to be certified<br />
** '''status''': URL status, can be one of the following:<br />
*** ''INPROGRESS'': URL certification is in progress<br />
*** ''ERROR'': The URL could not be certified<br />
*** ''READY'': The URL certificate is ready for download<br />
** '''progress''': Percentage of completion (for ''INPROGRESS'' status)<br />
** '''error''': Error code (for ''ERROR'' status):<br />
*** ''bad-url'': URL is not valid<br />
*** ''quota-error'': User has no certificate credits<br />
*** ''quota-disk-error'': User has no storage space<br />
*** ''max-size'': URL content is too large (more than 5Mb)<br />
*** ''too-many-redirects'': URL has launched more than 10 redirects<br />
*** ''http-error-XXX'': URL returned an HTTP status other than 200 (success) or 30X (redirects)<br />
*** ''internal-error'': Unexpected internal error while processing URL certificate<br />
** '''certificateId''': Certificate code (for ''READY'' status)<br />
** '''certificateUrl''': Certificate download URL (for ''READY'' status)<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden: the sharedkey or signature are not valid, or the specified job does not belong to the API client<br />
* '''404''' Not found: the job id is not correct.<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/web/status<br />
?sharedkey=5hmpod0d2vx7fnh6ysxab3olz<br />
&jobId=c498d3e0-aedb-48fe-82d5-5dec4270318b<br />
&signature=5784ad59c9fb400451887a138bf8ad36cee729d2<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"jobId":"c498d3e0-aedb-48fe-82d5-5dec4270318b",<br />
"results":[<br />
{"url":"http://www.safestamper.com","status":"READY",<br />
"certificateId":"160419-BQS763",<br />
"certificateUrl":"https://web.safestamper.com/certificate/160419-BQS763"},<br />
{"url":"NON-VALID-URL","status":"ERROR","error":"bad-url"},<br />
{"url":"http://www.safecreative.org","status":"INPROGRESS","progress":66}<br />
]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Web/stamp&diff=101Web/stamp2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>Launches a static web page certification job<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/web/stamp</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authorization key<br />
* '''url''N''''': The URLs you want to certificate. Multiple URLs can be specified as url1, url2, etc.<br />
* '''withUrls''': Include in the certificate a listing with all URLs accessed during page load (optional, defaults to false)<br />
* '''withHeaders''': Include in the certificate a listing with all headers received from each URL. Requires withUrls=true. (optional, defaults to false)<br />
* '''acceptCookies''': Accept cookies automatically when accessing the URL for certification (optional, defaults to false)<br />
* '''callback''': Callback URL to call when the job is finished (optional). See [[Web API callbacks]]<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
A job identifier that can be used to check the status of the operation with [[web/status]].<br />
<br />
The identifier is returned between double quotes, in order to be a valid JSON value.<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden, the sharedkey or signature are not valid<br />
* '''401''' Unauthorized, the authkey is not valid <br />
* '''429''' Your Safe Stamper user has no certification credits available<br />
* '''430''' Your Safe Stamper user has no storage space available<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/web/stamp<br />
?sharedkey=5hmpod0d2vx7fnh6ysxab3olz<br />
&url1=http%3A%2F%2Fwww.safestamper.com<br />
&url2=NON-VALID-URL<br />
&url3=http%3A%2F%2Fwww.safecreative.org<br />
&signature=aa052389e2d9d508dbb8fc0ef9cb72abc12c7109<br />
</pre><br />
<br />
RESPONSE:<br />
<pre><br />
"c498d3e0-aedb-48fe-82d5-5dec4270318b"<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Users&diff=99Users2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation get users authorizated by api client in Safe Stamper.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/users</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
* '''page:''' Page number to return (optional, defaults to 1)<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''pageSize''': Maximum number of users per page<br />
* '''count''': Total number of users<br />
* '''pageTotal''': Total number of pages <br />
* '''list''': array of JSON with the user auth data<br />
** '''authkey''': Authkey value<br />
** '''authorized''': State of authkey (true|false).<br />
** '''state''': State of Safe Stamper user (ACTIVE|DISABLED)<br />
** '''userCode''': Safe Stamper code of the authorizing user.<br />
** '''userMail''': Mail of the authorizing user.<br />
** '''userName''': Full name of the authorizing user.<br />
** '''accountType''': Account type of the authorizing user (BASIC|PREMIUM). <br />
** '''userType''': User type of the authorizing user (INDIVIDUAL|ORGANIZATION|OPERATOR). <br />
** '''mainUserAuthkey''': Authkey of main user for authorized operators. <br />
** '''availableCertificates''': Available certification credits to use web static, mail, file and photo services.<br />
** '''availableNavigations''': Available certification credits to use browsing session services.<br />
** '''availableTimestamps''': Available timestamp credits to use tsa services.<br />
** '''maxCertificateSize''': Máx size in bytes for certificates<br />
** '''maxCertificateSizeMb''': Máx size in MB for certificates<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden: the sharedkey is not valid<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/users<br />
?sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=35e157d8539fd66ca385fabb8967d4e8f180056f<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"pageSize":50,<br />
"count":1, <br />
"pageTotal":1,<br />
"list":[<br />
{<br />
"accountType":"PREMIUM",<br />
"authkey":"0021d81c-e4a5-4869-8384-2fd70cdb58ec",<br />
"authorized":true,<br />
"availableCertificates":50,<br />
"availableNavigations":3,<br />
"availableTimestamps":10,<br />
"maxCertificateSize":"22500000"<br />
"maxCertificateSizemB":"15"<br />
"state":"ACTIVE",<br />
"userCode":"1612020000541",<br />
"userMail" : "apitest@safecreative.org",<br />
"userName":"Api User Test"<br />
"userType":"INDIVIDUAL"<br />
<br />
}<br />
]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Status&diff=97Status2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>#REDIRECT [[Web/status]]</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Stamp&diff=95Stamp2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>#REDIRECT [[Web/stamp]]</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Signature_parameter&diff=93Signature parameter2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>Some API operations require a signature to authenticate the API client.<br />
<br />
To calculate the signature, follow this steps:<br />
<br />
* Build a string with all parameters ordered alphabetically, separated by ''&'' and '''without url-encoding'''<br />
* Get the bytes of the string, using UTF-8 encoding<br />
* Get the bytes of your private key, using UTF-8 encoding<br />
* Calculate the HMAC-SHA1 of the string bytes, with your private key bytes<br />
* Encode the signature bytes as hexadecimal digit pairs<br />
<br />
== Example ==<br />
<br />
'''Parameters:'''<br />
* url = <nowiki>https://www.google.com/search?q=Safe+Stamper&gws_rd=cr,ssl</nowiki><br />
* sharedkey = 789lq9o6im682tl0m1rej34ls<br />
<br />
'''Private key: '''<br />
* 1omnpo704w6u2ad2lxo2wrdm5<br />
<br />
<br />
'''String to sign: '''<br />
<pre><br />
sharedkey=789lq9o6im682tl0m1rej34ls&url=https://www.google.com/search?q=Safe+Stamper&gws_rd=cr,ssl<br />
</pre><br />
<br />
<br />
'''Content bytes''' (hexadeximal): <br />
<pre><br />
73 68 61 72 65 64 6b 65 79 3d 37 38 39 6c 71 39 |sharedkey=789lq9|<br />
6f 36 69 6d 36 38 32 74 6c 30 6d 31 72 65 6a 33 |o6im682tl0m1rej3|<br />
34 6c 73 26 75 72 6c 3d 68 74 74 70 73 3a 2f 2f |4ls&url=https://|<br />
77 77 77 2e 67 6f 6f 67 6c 65 2e 63 6f 6d 2f 73 |www.google.com/s|<br />
65 61 72 63 68 3f 71 3d 53 61 66 65 2b 53 74 61 |earch?q=Safe+Sta|<br />
6d 70 65 72 26 67 77 73 5f 72 64 3d 63 72 2c 73 |mper&gws_rd=cr,s|<br />
73 6c |sl|<br />
</pre><br />
<br />
<br />
'''Key bytes''' (hexadecimal)<br />
<pre><br />
31 6f 6d 6e 70 6f 37 30 34 77 36 75 32 61 64 32 |1omnpo704w6u2ad2|<br />
6c 78 6f 32 77 72 64 6d 35 0a |lxo2wrdm5.|<br />
</pre><br />
<br />
<br />
'''HMAC-SHA1'''<br />
<pre><br />
3e e8 b6 11 39 50 c0 c8 49 4b a0 3b 4f b8 d6 16 c7 fb 9a 25<br />
</pre><br />
<br />
<br />
'''Signature string:'''<br />
<pre><br />
3ee8b6113950c0c8494ba03b4fb8d616c7fb9a25<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Signature/tag&diff=91Signature/tag2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation set tag to document<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/signature/tag</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of document owner<br />
* '''code''': Code of document to modify<br />
* '''tag''': Tag to save in the document<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
HTTP 200 OK<br />
<br />
= HTTP Errors =<br />
<br />
* '''401''' Unauthorized: the authkey is not exist<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
* '''404''' Not found: the notification does not exist<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/signature/tag<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&code=b508e6e9-e5f6-4bb5-beef-c89bf6b50764<br />
&tag=Test<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE:<br />
<br />
HTTP 200 OK</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Signature/status&diff=89Signature/status2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>Returns the status of a document signature.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/signature/status</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authorization key, if needed<br />
* '''code''': Document code, returned by [[signature/sign]]<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''code''': Document code<br />
* '''title''': Document title<br />
* '''senderName''': Sender name<br />
* '''senderEmail''': Sender e-mail address<br />
* '''entryDate''': Date of upload<br />
* '''state''': Document state<br />
** '''PENDING''': The document doesn't have all its signatures<br />
** '''SIGNED''': The document has all its signatures and it has generated a signing certificate<br />
* '''certificateCode''': Code of the signature certificate, if it has already been generated (for SIGNED documents)<br />
* '''certificateUrl''': Validation URL of the signature certificate, if it has already been generated (for SIGNED documents)<br />
** If the document status is queried when the document has just been signed by its last signer, it may be in SIGNED state, but the certificate can still be in process and may not be available yet.<br />
* '''signatures''': The list of signatures<br />
** '''signerName''': Signer name<br />
** '''signerEmail''': Signer e-mail address<br />
** '''state''': Signature state<br />
*** '''PENDING''': The signer has not answered yet<br />
*** '''SIGNED''': The signer has signed the document<br />
** '''signerIP''': IP address from which the document was signed<br />
** '''signatureDate''': Date of signature<br />
<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden, the sharedkey or parameter signature are not valid<br />
* '''401''' Unauthorized, the authkey is not valid <br />
* '''404''' Document code not found<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/signature/sign<br />
?sharedkey=5hmpod0d2vx7fnh6ysxab3olz<br />
&code=b508e6e9-e5f6-4bb5-beef-c89bf6b50764<br />
&signature=6e83ffc1db2ea262c71426f2660882539d40ec60<br />
</pre><br />
<br />
RESPONSE:<br />
<pre><br />
{<br />
"code":"b508e6e9-e5f6-4bb5-beef-c89bf6b50764",<br />
"title":"Test Document",<br />
"senderName":"John Doe",<br />
"senderEmail":"john@example.com",<br />
"state":"PENDING",<br />
"entryDate":"2019-07-29T09:18:46Z",<br />
"signatures":[<br />
{<br />
"signerName":"Anne Example",<br />
"signerEmail":"anne@example.com",<br />
"signerIP":"127.0.0.1",<br />
"state":"SIGNED",<br />
"signatureDate":"2019-07-29T09:32:41Z"<br />
},<br />
{<br />
"signerName":"Bernie Beans",<br />
"signerEmail":"bernie@example.com",<br />
"state":"PENDING"<br />
}<br />
]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Signature/sign-pdf&diff=87Signature/sign-pdf2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>Uploads a PDF document for signing<br />
<br />
This operation must use an '''HTTP multipart/form-data post request'''.<br />
<br />
You can send an HTML text instead using [[signature/sign]].<br />
<br />
For each signature, the signer name and email or phone number must be provided.<br />
<br />
An email or SMS will be sent to each document signer with an URL they must visit to sign the document.<br />
When all signers have added their signature, a signature certificate will be generated and sent to all the document signers, and to the document sender e-mail address if specified.<br />
<br />
Document signing process status can be queried using [[signature/status]].<br />
<br />
If your API client has a [[API Overview#API callbacks|callback URL]], it will receive the following callbacks:<br />
* DOCUMENT_SIGNATURE: When a signer signs the document<br />
* SIGNATURE_CERTIFICATE: When the document signature certificate is ready<br />
<br />
These callbacks receive the same JSON as returned from [[signature/status]].<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/signature/sign-pdf</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey to certificate as authorized user (not needed if your shared key is already linked to your user) <br />
* '''pdf''': PDF document to sign<br />
* '''title''': Document title<br />
* '''lang''': Language to use in this document for the signatures page and for communication with signers (en,es)<br />
** ''en'': English<br />
** ''es'': Spanish (default)<br />
* '''signaturemode''': How the signers will sign the document (default: GRAPHIC)<br />
** ''GRAPHIC'': Graphic signature<br />
** ''SMS'': One-time code sent by SMS<br />
* '''sendername''': Name of the person or organization that sends this document to its signers. It will be referenced in the e-mail that the signers receive.<br />
* '''senderemail''': E-mail address of the person or organization that sends this document to its signers (optional). If included, the signed document certificate will also be sent to this e-mail address.<br />
* '''signername''N''''': Signer name for signature N<br />
* '''notifymode''N''''': How to send the signature link to signer N (default: EMAIL)<br />
** ''EMAIL'': Send link by e-mail<br />
** ''SMS'': Send link by SMS<br />
* '''signeremail''N''''': Signer e-mail address for signature N. Required for EMAIL notifymode<br />
* '''signerphone''N''''': Signer mobile phone number for signature N. Required for SMS notifymode<br />
** Phone number must include country prefix and no spaces or hyphens (eg. +34123456789)<br />
* '''signerlang''N''''': Language for communication with signer N. Optional, defaults to document language (lang parameter).<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
** '''NOTE:''' When calculating the signature use the file name as the value of ''pdf'' parameter<br />
<br />
= Returns =<br />
<br />
A JSON object, as returned by [[signature/status]] with the following fields:<br />
<br />
* '''code''': Code of the document,<br />
* '''title''': Title of the document,<br />
* '''entryDate''': Date when the document was sent to sign<br />
* '''senderName''': Name of sender<br />
* '''senderEmail''': Email of the sender<br />
* '''state''': State of the document (PENDING, SIGNED)<br />
** ''PENDING'': The document has been sent to its signers, but not all signatures have been received yet.<br />
** ''SIGNED'': The document has been signed by all its signers and is ready for download.<br />
* '''certificateCode''': Signature certificate code for SIGNED documents<br />
* '''certificateUrl''': Download URL for SIGNED documents<br />
* '''signatures''': Signatures data<br />
** '''signerName''': Name of signer<br />
** '''signerEmail''': Email of signer<br />
** '''state''': State of this signature<br />
*** ''PENDING'': This signer has not signed the document yet.<br />
*** ''SIGNED'': This signer has signed the document.<br />
** '''signerIP''': IP from which the document was signed (for SIGNED signatures)<br />
** '''signatureDate''': Date when the document was signed (for SIGNED signatures)<br />
<br />
= HTTP Errors =<br />
<br />
* '''401''' Unauthorized, the authkey is not valid<br />
* '''403''' Forbidden, the sharedkey or signature are not valid<br />
* '''400''' Parameter errors<br />
* '''429''' Your Safe Stamper user has no certification credits available<br />
* '''430''' Your Safe Stamper user has no storage space available<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/signature/sign-pdf<br />
<br />
Content-Type: multipart/form-data;<br />
boundary=90503bb6-f5b0-410f-97da-e86041ce17cd<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="authkey"<br />
<br />
0dbb406d-cc0c-4ef8-ae80-971ed108c2f9<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="sharedkey"<br />
<br />
axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="lang"<br />
<br />
en<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="title"<br />
<br />
Test PDF<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="sendername"<br />
<br />
John Doe<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="senderemail"<br />
<br />
johndoe@example.com<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="signername1"<br />
<br />
Anne Example<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="signeremail1"<br />
<br />
anne@example.com<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="signername2"<br />
<br />
Bernie Beans<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="signeremail2"<br />
<br />
bernie@example.com<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="signature"<br />
<br />
508c8bf78d43577f1d41db0c7a3c67c07518681c<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="pdf"; filename="lipsum.pdf"<br />
Content-Type: null<br />
<br />
<<< PDF contents >>><br />
<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd--<br />
<br />
</pre><br />
<br />
RESPONSE:<br />
<pre><br />
{<br />
"code":"0cdfbc8d-f9ad-4bb5-ba3b-2d33fe2d03bc",<br />
"title":"Test PDF",<br />
"senderName":"John Doe",<br />
"senderEmail":"jguillo@gmail.com",<br />
"state":"PENDING",<br />
"entryDate":"2020-09-16T10:38:05Z",<br />
"signatures":[<br />
{<br />
"signerName":"Anne Example",<br />
"signerEmail":"anne@example.com",<br />
"state":"PENDING"<br />
},<br />
{<br />
"signerName":"Bernie Beans",<br />
"signerEmail":"bernie@example.com",<br />
"state":"PENDING"<br />
}<br />
]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Signature/sign&diff=85Signature/sign2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>Uploads a document for signing<br />
<br />
This operation receives HTML text that will be converted to PDF.<br />
Any CSS or image file used by this HTML must be referenced using a full URL that is publicly accessible. <br />
You may also use <style> blocks for CSS styles and [http://wiki.developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs data urls] for images and other files. This HTML should be simple and only include formatted text and images. It will be sanitized before its conversion to PDF, removing any problematic content such as javascript code. <br />
<br />
You can upload a PDF file instead using [[signature/sign-pdf]].<br />
<br />
For each signature, the signer name and email is provided.<br />
<br />
An email or SMS will be sent to each document signer with an URL they must visit to sign the document.<br />
When all signers have added their signature, a signature certificate will be generated and sent to all the document signers, and to the document sender e-mail address if specified.<br />
<br />
Document signing process status can be queried using [[signature/status]].<br />
<br />
If your API client has a [[API Overview#API callbacks|callback URL]], it will receive the following callbacks:<br />
* DOCUMENT_SIGNATURE: When a signer signs the document<br />
* SIGNATURE_CERTIFICATE: When the document signature certificate is ready<br />
<br />
These callbacks receive the same JSON as returned from [[signature/status]].<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/signature/sign</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authorization key, if needed<br />
* '''html''': HTML of the document to sign<br />
* '''title''': Document title<br />
* '''lang''': Language for signer e-mails and signature pages (default: es)<br />
** ''es'': Spanish<br />
** ''en'': English<br />
* '''signaturemode''': How the signers will sign the document (default: GRAPHIC)<br />
** ''GRAPHIC'': Graphic signature<br />
** ''SMS'': One-time code sent by SMS<br />
* '''sendername''': Name of the person or organization that sends this document to its signers. It will be referenced in the e-mail that the signers receive.<br />
* '''senderemail''': E-mail address of the person or organization that sends this document to its signers (optional). If included, the signed document certificate will also be sent to this e-mail address.<br />
* '''signername''N''''': Signer name for signature N<br />
* '''notifymode''N''''': How to send the signature link to signer N (default: EMAIL)<br />
** ''EMAIL'': Send link by e-mail<br />
** ''SMS'': Send link by SMS<br />
* '''signeremail''N''''': Signer e-mail address for signature N. Required for EMAIL notifymode<br />
* '''signerphone''N''''': Signer mobile phone number for signature N. Required for SMS notifymode<br />
** Phone number must include country prefix and no spaces or hyphens (eg. +34123456789)<br />
* '''signerlang''N''''': Language for communication with signer N. Optional, defaults to document language (lang parameter).<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''code''': Document code<br />
* '''title''': Document title<br />
* '''senderName''': Sender name<br />
* '''senderEmail''': Sender e-mail address<br />
* '''entryDate''': Date of upload<br />
* '''state''': Document state<br />
** '''PENDING''': The document doesn't have all its signatures<br />
** '''SIGNED''': The document has all its signatures and it has generated a signing certificate<br />
* '''certificateCode''': Code of the signature certificate, if it has already been generated (for SIGNED documents)<br />
* '''certificateUrl''': Validation URL of the signature certificate, if it has already been generated (for SIGNED documents)<br />
** If the document status is queried when the document has just been signed by its last signer, it may be in SIGNED state, but the certificate may still be in process and the URL will not be available.<br />
* '''signatures''': The list of signatures<br />
** '''signerName''': Signer name<br />
** '''signerEmail''': Signer e-mail address<br />
** '''state''': Signature state<br />
*** '''PENDING''': The signer has not answered yet<br />
*** '''SIGNED''': The signer has signed the document<br />
** '''signerIP''': IP address from which the document was signed<br />
** '''signatureDate''': Date of signature<br />
<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden, the sharedkey or parameter signature are not valid<br />
* '''401''' Unauthorized, the authkey is not valid <br />
* '''400''' Parameter errors<br />
* '''429''' Your Safe Stamper user has no certification credits available<br />
* '''430''' Your Safe Stamper user has no storage space available<br />
<br />
= Example =<br />
<br />
This example uploads a document with 2 signers<br />
<br />
REQUEST (line jumps are not included in the request):<br />
<pre><br />
https://www.safestamper.com/api/signature/sign<br />
?sharedkey=5hmpod0d2vx7fnh6ysxab3olz<br />
&html=<html><br />
<body><h1>Test Document</h2><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p></body><br />
</html><br />
&title=Test Document<br />
&sendername=John Doe<br />
&senderemail=john@example.com<br />
&lang=es<br />
&signatureid1=signature1<br />
&signername1=Anne Example<br />
&signeremail1=anne@example.com<br />
&signatureid2=signature2<br />
&signername2=Bernie Beans<br />
&signeremail2=bernie@example.com<br />
&signature=602382cc08c8db6929d2aac76ee13fc1266294e1<br />
</pre><br />
<br />
RESPONSE:<br />
<pre><br />
{<br />
"code":"b508e6e9-e5f6-4bb5-beef-c89bf6b50764",<br />
"title":"Test Document",<br />
"senderName":"John Doe",<br />
"senderEmail":"john@example.com",<br />
"state":"PENDING",<br />
"entryDate":"2019-07-29T09:18:46Z",<br />
"signatures":[<br />
{ <br />
"signerName":"Anne Example",<br />
"signerEmail":"anne@example.com",<br />
"state":"PENDING"<br />
},<br />
{<br />
"signerName":"Bernie Beans",<br />
"signerEmail":"bernie@example.com",<br />
"state":"PENDING"<br />
}<br />
]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Signature/notes&diff=83Signature/notes2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation set tag to document<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/signature/notes</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of document owner<br />
* '''code''': Code of document to modify<br />
* '''notes''': Notes to save in the document<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
HTTP 200 OK<br />
<br />
= HTTP Errors =<br />
<br />
* '''401''' Unauthorized: the authkey is not exist<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
* '''404''' Not found: the notification does not exist<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/signature/tag<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&code=b508e6e9-e5f6-4bb5-beef-c89bf6b50764<br />
&notes=Notes<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE:<br />
<br />
HTTP 200 OK</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Safe_Stamper_Web_API_callbacks&diff=81Safe Stamper Web API callbacks2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>#REDIRECT [[Web API callbacks]]</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Partners_API&diff=79Partners API2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>These operations are only available for designated partners, as they allow to create and modify other users' accounts.<br />
<br />
<br />
= User authorization =<br />
<br />
To get an authorization key using the e-mail address and password of a user.<br />
<br />
== API operations ==<br />
<br />
* [[authorize]]: Returns an authorization key linked to a user, using their e-mail address and password<br />
<br />
<br />
<br />
= User API Reference =<br />
<br />
To create and link user accounts and activate professional services.<br />
<br />
== API operations ==<br />
These components are only available for Partners API:<br />
<br />
* [[newuser]]: Create user in Safe Stamper. Also used to create authorization for an existing Safe Stamper user.<br />
* [[modifyuser]]: Modify Safe Stamper user data.<br />
* [[addcredits]]: Add certification credits or navigation credits to the authorization.<br />
* [[newuserpack]]: Enable professional services linked to the authorization.<br />
* [[deleteuserpack]]: Disable professional services linked to the authorization.<br />
* [[users]]: Get users authorizated by api client<br />
<br />
<br />
<br />
= Operators API Reference =<br />
<br />
To manage operators (additional users) of subscription accounts. Operators are disabled when the subscription expire or is annulled.<br />
<br />
== API operations ==<br />
These components are only available for Partners API:<br />
<br />
* [[newoperator]]: Create an authorized operator for the subscription<br />
* [[modifyoperator]]: Modify Safe Stamper operator data.<br />
* [[deleteoperator]]: Delete authorized operator.<br />
* [[enableoperator]]: Enable access to authorized operator.<br />
* [[disableoperator]]: Disable access to authorized operator.<br />
* [[operators]]: Get authorized operator list from the subscription</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Operators&diff=77Operators2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation lists the authorized operators that can use the subscription account<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/operators</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of main user to list the authorized operators<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
= Returns =<br />
<br />
A JSON list object with the following fields:<br />
<br />
* '''authkey''': Authkey value<br />
* '''authorized''': State of authkey (true|false).<br />
* '''state''': State of Safe Stamper user (ACTIVE|DISABLED)<br />
* '''userCode''': Safe Stamper code of the authorizing user.<br />
* '''userMail''': Mail of the authorizing user.<br />
* '''userName''': Full name of the authorizing user.<br />
* '''accountType''': Account type of the authorizing user (BASIC|PREMIUM). <br />
* '''userType''': User type of the authorizing user (INDIVIDUAL|ORGANIZATION|OPERATOR). <br />
* '''mainUserAuthkey''': Authkey of main user for authorized operators. <br />
* '''availableCertificates''': Available certification credits to use web static, mail, file and photo services.<br />
* '''availableNavigations''': Available certification credits to use browsing session services.<br />
* '''availableTimestamps''': Available timestamp credits to use tsa services.<br />
* '''maxCertificateSize''': Máx size in bytes for certificates<br />
* '''maxCertificateSizeMb''': Máx size in MB for certificates<br />
<br />
<br />
= HTTP Errors =<br />
<br />
<br />
* '''401''' Unauthorized: the authkey is not valid<br />
* '''403''' Forbidden: the sharedkey is not valid<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/operators<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=f9e0222c2fcacbea7923552128a9d395d122e963<br />
</pre><br />
<br />
RESPONSE:<br />
<br />
[<br />
{<br />
"accountType": "PREMIUM",<br />
"authkey": "22644c3d-668c-492f-bef9-6ecf0fa8e495",<br />
"authorized": true,<br />
"state": "ACTIVE",<br />
"availableCertificates": 50,<br />
"availableNavigations": 6,<br />
"availableTimestamps": 0,<br />
"maxCertificateSize": 7500000,<br />
"maxCertificateSizeMb": 5,<br />
"userCode": "1812100000748",<br />
"userName": "Api Operator 1",<br />
"userMail": "api.operator@safecreative.org",<br />
"userType": "OPERATOR",<br />
"mainUserAuthkey": "0021d81c-e4a5-4869-8384-2fd70cdb58ec"<br />
},<br />
{<br />
"accountType": "PREMIUM",<br />
"authkey": "b25dde02-2376-4af0-bf0f-f8be600b0028",<br />
"authorized": true,<br />
"state": "DISABLED",<br />
"availableCertificates": 50,<br />
"availableNavigations": 6,<br />
"availableTimestamps": 0,<br />
"maxCertificateSize": 7500000,<br />
"maxCertificateSizeMb": 5,<br />
"userCode": "1812100000762",<br />
"userName": "Api Operator 2",<br />
"userMail": "api.operator2@safecreative.org",<br />
"userType": "OPERATOR",<br />
"mainUserAuthkey": "0021d81c-e4a5-4869-8384-2fd70cdb58ec"<br />
}<br />
]</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Notifications&diff=75Notifications2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation lists the notifications of the authorizing user.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/notifications</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authorization key<br />
* '''fromDate''': Return notifications sent from this date on (optional, format yyyy-MM-dd)<br />
* '''toDate''': Return notifications sent up to this date (optional, format yyyy-MM-dd)<br />
* '''filter''': Text for searching notifications (optional)<br />
* '''page''': Page number to return (optional, defaults to 1)<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''pageSize''': Maximum number of notifications per page<br />
* '''count''': Total number of notifications<br />
* '''pageTotal''': Total number of pages <br />
* '''list''': array of JSON with the notification data<br />
** '''entryDate''': Date of notification<br />
** '''code''': Notification code<br />
** '''subject''': Subject of notification<br />
** '''body''': Body content of notification<br />
** '''recipientType''': Send type of the notification<br />
** '''recipientMail''': E-mail address of the notification recipient<br />
** '''recipientPhone''': Phone of the notification recipient<br />
** '''recipientName''': Name of the notification recipient<br />
** '''attachmentName''': Attachment name of notification<br />
** '''state''': State of notification<br />
*** ''PENDING'' The notification is pending to read<br />
*** ''READ'' The notificaction has been read<br />
** '''certificates''': List of certificates generated from this notification<br />
*** '''entryDate''': Date of certificate<br />
*** '''code''': Certificate code<br />
*** '''url''': Public URL for certificate download<br />
** '''readings''': List of readings of this notification<br />
*** '''ip''': IP from which the notification was read<br />
*** '''country''': Country code from which the notification was read<br />
*** '''city''': City from which the notification was read<br />
*** '''date''': Date read<br />
*** '''downloadAttachment''': Indicates if the attachment was downloaded<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
* '''401''' Unauthorized: authkey is not valid or not authorized<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/notifications<br />
?authkey=0dbb406d-cc0c-4ef8-ae80-971ed108c2f9<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"pageSize": 50,<br />
"count": 1,<br />
"pageTotal": 1,<br />
"list": [<br />
{<br />
"entryDate": "2017-03-16T12:59:08Z",<br />
"code": "170316-6K5D2Q",<br />
"state": "READ",<br />
"subject": "Example notification",<br />
"body": "Notification text",<br />
"recipientType": "EMAIL",<br />
"recipientMail": "jdoe@example.com",<br />
"recipientPhone": "",<br />
"recipientName": "John Doe",<br />
"certificates": [<br />
{<br />
"entryDate": "2017-03-16T12:59:44Z",<br />
"code": "170316-WMZMFS",<br />
"url": "http:\/\/www.safestamper.com\/certificate\/170316-WMZMFS",<br />
}],<br />
"readings": [<br />
{<br />
"ip": "127.0.0.1",<br />
"date": "2017-03-16T12:59:34Z",<br />
"downloadAttachment": "false"<br />
}]<br />
}}<br />
<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Notification/tag&diff=73Notification/tag2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation set tag to notification<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/notification/tag</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of notification owner<br />
* '''code''': Code of notification to modify<br />
* '''tag''': Tag to save in the notification<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
HTTP 200 OK<br />
<br />
= HTTP Errors =<br />
<br />
* '''401''' Unauthorized: the authkey is not exist<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
* '''404''' Not found: the notification does not exist<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/notification/tag<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&code=170316-6K5D2Q<br />
&tag=Test<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE:<br />
<br />
HTTP 200 OK</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Notification/send&diff=71Notification/send2023-10-17T11:27:28Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation sends a notification to destinataries<br />
<br />
= URL =<br />
<nowiki>https://web.safestamper.com/api/notification/send</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of notification owner<br />
* '''recipientTypeN''': (multivalue) Send type of notification. <br />
* '''recipientNameN''': (multivalue) Name of recipient of notification<br />
* '''recipientMailN''': (multivalue) Mail of recipient of notification. In recipientTypeN equals EMAIL<br />
* '''recipientSmsN''': (multivalue) Phone of recipient of notification. In recipientTypeN equals SMS<br />
* '''subject''': Subject of the notification<br />
* '''body''': text of the notification<br />
* '''attachment''': Attach file of notification<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
** '''NOTE''': When calculating the signature use the attachment file name as the value of file parameter<br />
<br />
= Returns =<br />
<br />
A JSON object with list of following fields:<br />
<br />
* '''entryDate''': Date of notification<br />
* '''code''': Notification code<br />
* '''uuid''': Notification uuid<br />
* '''subject''': Subject of notification<br />
* '''body''': Body content of notification<br />
* '''recipientType''': Send type of the notification<br />
* '''recipientMail''': E-mail address of the notification recipient<br />
* '''recipientPhone''': Phone of the notification recipient<br />
* '''recipientName''': Name of the notification recipient<br />
* '''attachmentName''': Attachment name of notification<br />
* '''state''': State of notification<br />
** ''PENDING'' The notification is pending to read<br />
** ''READ'' The notificaction has been read<br />
<br />
= HTTP Errors =<br />
<br />
* '''401''' Unauthorized: the authkey does not exist or is not authorized<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://web.safestamper.com/api/notification/send<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&recipientType1=EMAIL<br />
&recipientMail1=sample@mail.com<br />
&recipientName1=Sample<br />
&subject=Example+notification<br />
&body=Notification+text<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
[<br />
{<br />
"entryDate": "2017-03-16T12:59:08Z",<br />
"code": "170316-6K5D2Q",<br />
"uuid": "a59e091e-2338-4037-b383-91235bc0f9f3",<br />
"state": "PENDING",<br />
"subject": "Example notification",<br />
"body": "Notification text"<br />
"recipientType": "EMAIL",<br />
"recipientMail": "sample@mail.com",<br />
"recipientName": "Sample"<br />
"recipientPhone": ""<br />
}<br />
]<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Notification/notes&diff=69Notification/notes2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation set notes to notification<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/notification/notes</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of notification owner<br />
* '''code''': Code of notification to modify<br />
* '''notes''': Notes to save in the notification<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
HTTP 200 OK<br />
<br />
= HTTP Errors =<br />
<br />
* '''401''' Unauthorized: the authkey is not exist<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
* '''404''' Not found: the notification does not exist<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/notification/tag<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&code=170316-6K5D2Q<br />
&notes=Notes<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE:<br />
<br />
HTTP 200 OK</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Notification/get&diff=67Notification/get2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation get info of a notification. <br />
<br />
= URL =<br />
<nowiki>https://web.safestamper.com/api/notification/get</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of notification owner<br />
* '''code''': Code of notification to get info<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''entryDate''': Date of notification<br />
* '''code''': Notification code<br />
* '''subject''': Subject of notification<br />
* '''body''': Body content of notification<br />
* '''recipientType''': Send type of the notification<br />
* '''recipientMail''': E-mail address of the notification recipient<br />
* '''recipientPhone''': Phone of the notification recipient<br />
* '''recipientName''': Name of the notification recipient<br />
* '''attachmentName''': Attachment name of notification<br />
* '''state''': State of notification<br />
** ''PENDING'' The notification is pending to read<br />
** ''READ'' The notificaction has been read<br />
* '''certificates''': List of certificates generated from this notification<br />
** '''entryDate''': Date of certificate<br />
** '''code''': Certificate code<br />
** '''url''': Public URL for certificate download<br />
* '''readings''': List of readings of this notification<br />
** '''ip''': IP from which the notification was read<br />
** '''country''': Country code from which the notification was read<br />
** '''city''': City from which the notification was read<br />
** '''date''': Date read<br />
** '''downloadAttachment''': Indicates if the attachment was downloaded<br />
<br />
= HTTP Errors =<br />
<br />
* '''401''' Unauthorized: the authkey does not exist or is not authorized<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
* '''404''' Not found: the notification does not exist or does not belong to the user<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://web.safestamper.com/api/notification/get<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&code=170316-6K5D2Q<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"entryDate": "2017-03-16T12:59:08Z",<br />
"code": "170316-6K5D2Q",<br />
"state": "READED",<br />
"subject": "Example notification",<br />
"body": "Notification text",<br />
"recipientType": "EMAIL",<br />
"recipientMail": "jdoe@example.com",<br />
"recipientPhone": "",<br />
"recipientName": "John Doe",<br />
"certificates": [<br />
{<br />
"entryDate": "2017-03-16T12:59:44Z",<br />
"code": "170316-WMZMFS",<br />
"url": "http:\/\/dev.safestamper.com:9001\/certificate\/170316-WMZMFS",<br />
}],<br />
"readings": [<br />
{<br />
"ip": "127.0.0.1",<br />
"date": "2017-03-16T12:59:34Z",<br />
"downloadAttachment": "false"<br />
}]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Notification/generatecertificate&diff=65Notification/generatecertificate2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation generates a new certificate of this notification. ''Deprecated''<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/notification/generatecertificate</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of notification owner<br />
* '''code''': Code of notification<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''entryDate''': Date of certificate<br />
* '''code''': Certificate code<br />
* '''url''': Public URL for certificate download<br />
<br />
= HTTP Errors =<br />
<br />
* '''401''' Unauthorized: the authkey is not exist<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
* '''404''' Not found: the notification does not exist<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/notification/generatecertificate<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&code=170316-6K5D2Q<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"entryDate": "2017-03-16T12:59:44Z",<br />
"code": "170316-WMZMFS",<br />
"url": "http:\/\/www.safestamper.com\/certificate\/170316-WMZMFS"<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Notification/delete&diff=63Notification/delete2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation deletes a notification from Safe Stamper<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/notification/delete</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of notification owner<br />
* '''code''': Code of notification to delete<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
HTTP 200 OK<br />
<br />
= HTTP Errors =<br />
<br />
* '''401''' Unauthorized: the authkey is not exist<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
* '''404''' Not found: the notification does not exist<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/notification/delete<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&code=170316-6K5D2Q<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE:<br />
<br />
HTTP 200 OK</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Notification/close&diff=61Notification/close2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation close a notification. <br />
<br />
= URL =<br />
<nowiki>https://web.safestamper.com/api/notification/close</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of notification owner<br />
* '''code''': Code of notification to close<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''entryDate''': Date of notification<br />
* '''code''': Notification code<br />
* '''subject''': Subject of notification<br />
* '''body''': Body content of notification<br />
* '''recipientType''': Send type of the notification<br />
* '''recipientMail''': E-mail address of the notification recipient<br />
* '''recipientPhone''': Phone of the notification recipient<br />
* '''recipientName''': Name of the notification recipient<br />
* '''attachmentName''': Attachment name of notification<br />
* '''state''': State of notification<br />
** ''PENDING'' The notification is pending to read<br />
** ''READ'' The notificaction has been read<br />
* '''certificates''': List of certificates generated from this notification<br />
** '''entryDate''': Date of certificate<br />
** '''code''': Certificate code<br />
** '''url''': Public URL for certificate download<br />
* '''readings''': List of readings of this notification<br />
** '''ip''': IP from which the notification was read<br />
** '''country''': Country code from which the notification was read<br />
** '''city''': City from which the notification was read<br />
** '''date''': Date read<br />
** '''downloadAttachment''': Indicates if the attachment was downloaded<br />
<br />
= HTTP Errors =<br />
<br />
* '''401''' Unauthorized: the authkey does not exist or is not authorized<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
* '''404''' Not found: the notification does not exist or does not belong to the user<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://web.safestamper.com/api/notification/get<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&code=170316-6K5D2Q<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"entryDate": "2017-03-16T12:59:08Z",<br />
"code": "170316-6K5D2Q",<br />
"state": "READED",<br />
"subject": "Example notification",<br />
"body": "Notification text",<br />
"recipientType": "EMAIL",<br />
"recipientMail": "jdoe@example.com",<br />
"recipientPhone": "",<br />
"recipientName": "John Doe",<br />
"certificates": [<br />
{<br />
"entryDate": "2017-03-16T12:59:44Z",<br />
"code": "170316-WMZMFS",<br />
"url": "http:\/\/dev.safestamper.com:9001\/certificate\/170316-WMZMFS",<br />
}],<br />
"readings": [<br />
{<br />
"ip": "127.0.0.1",<br />
"date": "2017-03-16T12:59:34Z",<br />
"downloadAttachment": "false"<br />
}]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Newuserpack&diff=59Newuserpack2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation activates a professional or corporate account for the user and links it to the authorization, so it will be removed if the authorization is deleted.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/newuserpack</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey to enable subscription services<br />
* '''accounttype''': Account type that will be enabled to the user (professional|corporate|premium). Deprecated (in future version all userpacks are premium and this field will be removed)<br />
* '''usercount''': Number of users can be use this subscription. Min value: 1. Required for premium accounttype<br />
* '''extranavigations''': Number of extra navigations to add to this subscription. Min value: 0. Optional for premium accounttype<br />
* '''extrasigneddocuments''': Number of extra signed document credits to add to this subscription. Min value: 0. Optional for premium accounttype<br />
* '''timestamppacks''': Number of daily timestamp packs to add to this subscription. Min value: 0. Optional for premium accounttype<br />
* '''authcodes''': Indicate if authorization codes are enabled for this subscription. Values: true/false. Optional for premium accounttype<br />
* '''unlimitedsenders''': Indicate if alternative sender e-mails are enabled for this subscription. Values: true/false. Optional for premium accounttype<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
HTTP 200 OK<br />
<br />
= HTTP Errors =<br />
<br />
* '''400''' Bad Request: the accounttype is not valid<br />
* '''401''' Unauthorized: authkey is not valid<br />
* '''403''' Forbidden: <br />
** Sharedkey or signature is not valid<br />
** API client is not a partner<br />
* '''431''' The user already has a professional or corporate account<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/newuserpack<br />
?accounttype=premium&authcodes=true&authkey=8639e12a-810c-4c51-8a62-c1b0fcf58bfd<br />
&extranavigations=5&sharedkey=2w32i03wypba9l7ajyv8ukr23&signature=9ed808c15841a163836f6b2bccc47f6efb960ce9<br />
&timestamppacks=0&unlimitedsenders=false&usercount=3<br />
</pre><br />
<br />
RESPONSE:<br />
<br />
HTTP 200 OK</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Newuser&diff=57Newuser2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation creates a user in Safe Stamper, or creates an authorization for an existing Safe Stamper user.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/newuser</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
* '''mail*:''' user mail<br />
* '''firstName?:''' first name of the user<br />
* '''lastName?:''' last name of the user<br />
* '''address1:''' user address line 1<br />
* '''address2:''' user address line 2<br />
* '''zip:''' user address zip code<br />
* '''city:''' user address zip city<br />
* '''countrycode:''' user address country ISO code (Default 'ES')<br />
* '''language:''' user preferred language (es|en) Defaults to the language of the api client.<br />
* '''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.<br />
<br />
Partners may include this param:<br />
<br />
* '''accounttype''': account type that will be enabled to the user (professional|corporate)<br />
<br />
<nowiki>*</nowiki> Required parameter<br />
<br />
(?): At least provide one field (First or last name)<br />
<br />
= Returns =<br />
<br />
A JSON object with the authkey status, as returned in [[authstate]]:<br />
<br />
* '''authkey''': Authkey value<br />
* '''authorized''': State of authkey (true|false).<br />
* '''state''': State of Safe Stamper operator (ACTIVE|DISABLED)<br />
* '''userCode''': Safe Stamper code of the user.<br />
* '''userMail''': Mail of the user.<br />
* '''userName''': Full name of the user.<br />
* '''accountType''': Account type of the main user (BASIC|PREMIUM). <br />
* '''userType''': User type of the user (INDIVIDUAL|ORGANIZATION). <br />
* '''availableCertificates''': Available certification credits to use web static, mail, file and photo services.<br />
* '''availableNavigations''': Available certification credits to use browsing session services.<br />
* '''availableTimestamps''': Available timestamp credits to use tsa services.<br />
* '''maxCertificateSize''': Máx size in bytes for certificates<br />
* '''maxCertificateSizeMb''': Máx size in MB for certificates<br />
<br />
= HTTP Errors =<br />
<br />
* '''400''' Bad Request: the countrycode or accounttype are not valid, or firstname and lastname are empty <br />
* '''401''' Unauthorized: accounttype is sended but you are not a partner<br />
* '''403''' Forbidden: the sharedkey is not valid, or the e-mail address already exists in Safe Stamper or Safe Creative<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/newuser<br />
?accounttype=premium<br />
&mail=apitest@safecreative.org<br />
&firstname=Api%2C+User<br />
&lastname=Test<br />
&address1=C%2F+Bari%2C+39%2C+2%C2%AA+Planta<br />
&address2=%28Sede+Central%29<br />
&zip=50197<br />
&city=Zaragoza<br />
&countrycode=ES<br />
&language=es<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=35e157d8539fd66ca385fabb8967d4e8f180056f<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"accountType":"PREMIUM",<br />
"authkey":"8639e12a-810c-4c51-8a62-c1b0fcf58bfd",<br />
"authorized":true,<br />
"availableCertificates":50,<br />
"availableNavigations":1,<br />
"availableTimestamps":10,<br />
"maxCertificateSize":"22500000"<br />
"maxCertificateSizemB":"15"<br />
"state":"ACTIVE",<br />
"userCode":"1612020000541",<br />
"userMail" : "apitest@safecreative.org",<br />
"userName":"Api User Test"<br />
"userType":"INDIVIDUAL"<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Newoperator&diff=55Newoperator2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation creates an authorized operator for the subscription. The operator can use the suscription account but just allow manage the own data and certificates<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/newoperator</nowiki><br />
<br />
= Parameters =<br />
* '''authkey''': Authkey of main user<br />
* '''sharedkey''': Your API client shared key<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
* '''mail:''' user mail<br />
* '''firstName?:''' first name of the user<br />
* '''lastName?:''' last name of the user<br />
= Returns =<br />
<br />
A JSON object with the authkey status, as returned in [[authstate]]:<br />
<br />
* '''authkey''': Authkey value<br />
* '''authorized''': State of authkey (true|false).<br />
* '''state''': State of Safe Stamper operator (ACTIVE|DISABLED)<br />
* '''userCode''': Safe Stamper code of the authorizing operator.<br />
* '''userMail''': Mail of the authorizing operator.<br />
* '''userName''': Full name of the authorizing operator.<br />
* '''accountType''': Account type of the main user (PREMIUM). <br />
* '''userType''': User type of the authorizing operator (OPERATOR). <br />
* '''mainUserAuthkey''': Authkey of main user for authorized operator. <br />
* '''availableCertificates''': Available certification credits to use web static, mail, file and photo services.<br />
* '''availableNavigations''': Available certification credits to use browsing session services.<br />
* '''availableTimestamps''': Available timestamp credits to use tsa services.<br />
* '''maxCertificateSize''': Máx size in bytes for certificates<br />
* '''maxCertificateSizeMb''': Máx size in MB for certificates<br />
<br />
= HTTP Errors =<br />
<br />
* '''400''' Bad Request: the countrycode or accounttype are not valid, or firstname and lastname are empty <br />
* '''401''' Unauthorized: accounttype is sended but you are not a partner<br />
* '''403''' Forbidden: the sharedkey is not valid, is mail exists in Safe Stamper and user is deleted<br />
* '''429''' Forbidden: user doesn't have quota available for create new operator<br />
* '''432''' Forbidden: user doesn't have professional subscription enabled<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/newoperator<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&mail=api.operator@safecreative.org<br />
&firstname=Api%2C+Operator<br />
&lastname=1<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=35e157d8539fd66ca385fabb8967d4e8f180056f<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"accountType": "PREMIUM",<br />
"authkey": "22644c3d-668c-492f-bef9-6ecf0fa8e495",<br />
"authorized": true,<br />
"state": "ACTIVE",<br />
"availableCertificates": 50,<br />
"availableNavigations": 6,<br />
"availableTimestamps": 0,<br />
"maxCertificateSize": 7500000,<br />
"maxCertificateSizeMb": 5,<br />
"userCode": "1812100000748",<br />
"userName": "Api Operator 1",<br />
"userMail": "api.operator@safecreative.org",<br />
"userType": "OPERATOR",<br />
"mainUserAuthkey": "0021d81c-e4a5-4869-8384-2fd70cdb58ec"<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Modifyuser&diff=53Modifyuser2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation modify Safe Stamper user data.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/modifyuser</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authorization key<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
* '''mail:''' user mail<br />
* '''firstName:''' first name of the user<br />
* '''lastName:''' last name of the user<br />
* '''address1:''' user address line 1<br />
* '''address2:''' user address line 2<br />
* '''zip:''' user address zip code<br />
* '''city:''' user address zip city<br />
* '''countrycode:''' user address country ISO code (Default 'ES')<br />
* '''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.<br />
<br />
= Returns =<br />
<br />
A JSON object with the authkey status, as returned in [[authstate]]:<br />
<br />
* '''authkey''': Authkey value<br />
* '''authorized''': State of authkey (true|false).<br />
* '''state''': State of Safe Stamper operator (ACTIVE|DISABLED)<br />
* '''userCode''': Safe Stamper code of the user.<br />
* '''userMail''': Mail of the user.<br />
* '''userName''': Full name of the user.<br />
* '''accountType''': Account type of the main user (BASIC|PREMIUM). <br />
* '''userType''': User type of the user (INDIVIDUAL|ORGANIZATION). <br />
* '''availableCertificates''': Available certification credits to use web static, mail, file and photo services.<br />
* '''availableNavigations''': Available certification credits to use browsing session services.<br />
* '''availableTimestamps''': Available timestamp credits to use tsa services.<br />
* '''maxCertificateSize''': Máx size in bytes for certificates<br />
* '''maxCertificateSizeMb''': Máx size in MB for certificates<br />
<br />
= HTTP Errors =<br />
<br />
* '''400''' Bad Request: the countrycode or accounttype are not valid, or firstname and lastname are empty <br />
* '''401''' Unauthorized: accounttype is sended but you are not a partner<br />
* '''403''' Forbidden: the sharedkey is not valid, is mail exists in Safe Stamper<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/modifyuser<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&accounttype=professional<br />
&mail=apitest@safecreative.org<br />
&firstname=Api%2C+User<br />
&lastname=Test 2<br />
&address1=C%2F+Bari%2C+39%2C+2%C2%AA+Planta<br />
&address2=%28Sede+Central%29<br />
&zip=50197<br />
&city=Zaragoza<br />
&countrycode=ES<br />
&language=es<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=35e157d8539fd66ca385fabb8967d4e8f180056f<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"accountType":"PREMIUM",<br />
"authkey":"8639e12a-810c-4c51-8a62-c1b0fcf58bfd",<br />
"authorized":true,<br />
"availableCertificates":50,<br />
"availableNavigations":1,<br />
"availableTimestamps":10,<br />
"maxCertificateSize":"22500000"<br />
"maxCertificateSizemB":"15"<br />
"state":"ACTIVE",<br />
"userCode":"1612020000541",<br />
"userMail" : "apitest@safecreative.org",<br />
"userName":"Api User Test 2"<br />
"userType":"INDIVIDUAL"<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Modifyoperator&diff=51Modifyoperator2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation modify Safe Stamper operator data.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/modifyoperator</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authorization key of operator<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
* '''mail:''' operator mail<br />
* '''firstName:''' first name of the operator<br />
* '''lastName:''' last name of the operator<br />
<br />
= Returns =<br />
<br />
A JSON object with the authkey status, as returned in [[authstate]]:<br />
<br />
* '''authkey''': Authkey value<br />
* '''authorized''': State of authkey (true|false).<br />
* '''state''': State of Safe Stamper operator (ACTIVE|DISABLED)<br />
* '''userCode''': Safe Stamper code of the authorizing operator.<br />
* '''userMail''': Mail of the authorizing operator.<br />
* '''userName''': Full name of the authorizing operator.<br />
* '''accountType''': Account type of the main user (PREMIUM). <br />
* '''userType''': User type of the authorizing operator (OPERATOR). <br />
* '''mainUserAuthkey''': Authkey of main user for authorized operator. <br />
* '''availableCertificates''': Available certification credits to use web static, mail, file and photo services.<br />
* '''availableNavigations''': Available certification credits to use browsing session services.<br />
* '''availableTimestamps''': Available timestamp credits to use tsa services.<br />
* '''maxCertificateSize''': Máx size in bytes for certificates<br />
* '''maxCertificateSizeMb''': Máx size in MB for certificates<br />
<br />
= HTTP Errors =<br />
<br />
* '''400''' Bad Request: the countrycode or accounttype are not valid, or firstname and lastname are empty <br />
* '''401''' Unauthorized: accounttype is sended but you are not a partner<br />
* '''403''' Forbidden: the sharedkey is not valid, is mail exists in Safe Stamper<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/modifyoperator<br />
?authkey=22644c3d-668c-492f-bef9-6ecf0fa8e495<br />
&mail=api.operator3@safecreative.org<br />
&firstname=Api%2C+Operator<br />
&lastname=3<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=35e157d8539fd66ca385fabb8967d4e8f180056f<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"accountType": "PREMIUM",<br />
"authkey": "22644c3d-668c-492f-bef9-6ecf0fa8e495",<br />
"authorized": true,<br />
"state": "ACTIVE",<br />
"availableCertificates": 50,<br />
"availableNavigations": 6,<br />
"availableTimestamps": 0,<br />
"maxCertificateSize": 7500000,<br />
"maxCertificateSizeMb": 5,<br />
"userCode": "1812100000748",<br />
"userName": "Api Operator 3",<br />
"userMail": "api.operator3@safecreative.org",<br />
"userType": "OPERATOR",<br />
"mainUserAuthkey": "0021d81c-e4a5-4869-8384-2fd70cdb58ec"<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Main_Page&diff=49Main Page2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div><strong>MediaWiki has been installed.</strong><br />
<br />
Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.<br />
<br />
== Getting started ==<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]<br />
* [https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/ MediaWiki release mailing list]<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]<br />
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Login&diff=47Login2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation login to user in Safe Stamper platform and redirect to url<br />
<br />
= URL =<br />
<nowiki>https://web.safestamper.com/api/login</nowiki><br />
<br />
= Parameters =<br />
<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey to login in Safe Stamper<br />
* '''r''': Encoded URL to redirect after login<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden: the sharedkey or authkey are not valid<br />
* '''401''' Unauthorize: the authkey is not valid<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://web.safestamper.com/api/login<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec&r=https%3A%2F%2Fwww.safestamper.com%2Fbuy%2F3&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh&signature=1b36f9370582a10cba45483a1bec1e16ea84f4d4<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=File/stamp&diff=45File/stamp2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>Sends a file to certificate.<br />
<br />
It must use an HTTP multipart/form-data post request.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/file/stamp</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey to certificate as authorized user. <br />
* '''file''': File to certificate<br />
* '''storefile''': Indicate if store file in SafeStamper server ("true"|"false")<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
** '''NOTE:''' When calculating the signature use the file name as the value of ''file'' parameter<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''entryDate''': Date of certificate<br />
* '''code''': Code of certificate,<br />
* '''url''': URL of certificate download<br />
* '''properties''': JSON with the properties the certificate<br />
** '''filename''': File name of the certificate<br />
** '''size''': Size of file of the certificate (returned as a string)<br />
** '''md5''': MD5 hash of file of the certificate<br />
** '''sha1''': SHA1 hash of file of the certificate<br />
** '''sha256''': SHA256 hash of file of the certificate<br />
** '''sha512''': SHA512 hash of file of the certificate<br />
<br />
= HTTP Errors =<br />
<br />
* '''401''' Unauthorized, the authkey is not valid<br />
* '''403''' Forbidden, the sharedkey or signature are not valid<br />
* '''429''' Your Safe Stamper user has no certification credits available<br />
* '''430''' Your Safe Stamper user has no storage space available<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/file/stamp<br />
<br />
Content-Type: multipart/form-data;<br />
boundary=90503bb6-f5b0-410f-97da-e86041ce17cd<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="authkey"<br />
<br />
0dbb406d-cc0c-4ef8-ae80-971ed108c2f9<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="storefile"<br />
<br />
true<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="sharedkey"<br />
<br />
axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="signature"<br />
<br />
508c8bf78d43577f1d41db0c7a3c67c07518681c<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd<br />
Content-Disposition: form-data; name="file"; filename="test.file"<br />
Content-Type: null<br />
<br />
<<< Contents of file >>><br />
<br />
--90503bb6-f5b0-410f-97da-e86041ce17cd--<br />
<br />
</pre><br />
<br />
RESPONSE:<br />
<pre><br />
{<br />
"entryDate":"2016-12-05T10:49:11Z",<br />
"code":"161205-4MR4ML",<br />
"url":"http://www.safestamper.com/certificate/161205-4MR4ML",<br />
"properties": {<br />
"filename":"test.file",<br />
"size":"3070",<br />
"md5":"9f7c1b879255cf5661f721d4fec6cbf2",<br />
"sha1":"7baf9446524cb1886f17fbd9756102b44d85585f",<br />
"sha256":"b42468bd6afa45d8f64c042fc116409748cdaf0214c47d8ad43aa4728ece7c03",<br />
"sha512":"5d04ec2d846141d2dcbc8d1d2629709dc63b8bf5b9f0e49836db527ae11c4b10ce797e184b8fa5fb0755fc444c62a93af0b0174c4d8ef68d82fe977a52dd4079" <br />
}<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Enableoperator&diff=43Enableoperator2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation enables a existing authorized operator in state DISABLED to use the subscription account. <br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/enableoperator</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of authorized operator to enable<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
HTTP 200 OK<br />
<br />
= HTTP Errors =<br />
<br />
<br />
* '''401''' Unauthorized: the authkey is not valid<br />
* '''403''' Forbidden: the sharedkey is not valid, user is not operator or operator is not disabled<br />
* '''429''' Forbidden: user doesn't have quota available for enable a operator<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/enableoperator<br />
?authkey=22644c3d-668c-492f-bef9-6ecf0fa8e495<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=f9e0222c2fcacbea7923552128a9d395d122e963<br />
</pre><br />
<br />
RESPONSE:<br />
<br />
HTTP 200 OK</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Disableoperator&diff=41Disableoperator2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation disables an authorized operator to use the subscription account. <br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/disableoperator</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of authorized operator to disable<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
HTTP 200 OK<br />
<br />
= HTTP Errors =<br />
<br />
<br />
* '''401''' Unauthorized: the authkey is not valid<br />
* '''403''' Forbidden: the sharedkey is not valid, user is not operator or operator is not active<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/disableoperator<br />
?authkey=22644c3d-668c-492f-bef9-6ecf0fa8e495<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=f9e0222c2fcacbea7923552128a9d395d122e963<br />
</pre><br />
<br />
RESPONSE:<br />
<br />
HTTP 200 OK</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Deleteuserpack&diff=39Deleteuserpack2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation disables the professional services that are linked to the authorization<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/deleteuserpack</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey to disable professional services<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
HTTP 200 OK<br />
<br />
= HTTP Errors =<br />
<br />
<br />
* '''401''' Unauthorized: the authkey is not valid<br />
* '''403''' Forbidden: the sharedkey is not valid<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/deleteuserpack<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=f9e0222c2fcacbea7923552128a9d395d122e963<br />
</pre><br />
<br />
RESPONSE:<br />
<br />
HTTP 200 OK</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Deleteoperator&diff=37Deleteoperator2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation deletes the authorized operator. All the operator's certificates will be owned by the main user<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/deleteoperator</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of authorized operator to delete<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
HTTP 200 OK<br />
<br />
= HTTP Errors =<br />
<br />
<br />
* '''401''' Unauthorized: the authkey is not valid<br />
* '''403''' Forbidden: the sharedkey is not valid<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/deleteoperator<br />
?authkey=22644c3d-668c-492f-bef9-6ecf0fa8e495<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=f9e0222c2fcacbea7923552128a9d395d122e963<br />
</pre><br />
<br />
RESPONSE:<br />
<br />
HTTP 200 OK</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Deleteauth&diff=35Deleteauth2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation deletes a user's authorization and disables all professional services linked to the authorization.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/deleteauth</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey to delete<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
HTTP 200 OK<br />
<br />
= HTTP Errors =<br />
<br />
* '''401''' Unauthorized: the authkey is not valid<br />
* '''403''' Forbidden: the sharedkey is not valid<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/deleteuser<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=f9e0222c2fcacbea7923552128a9d395d122e963<br />
</pre><br />
<br />
RESPONSE:<br />
<br />
HTTP 200 OK</div>Adminwikihttps://wiki.safestamper.com/index.php?title=Createauth&diff=33Createauth2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation creates an authkey pending authorization.<br />
<br />
After creating the authkey, the application must redirect the user to the authorization web page: '''<nowiki>https://www.safestamper.com/authorize/<AUTHKEY></nowiki>'''<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/createauth</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''authkey''': Authkey value<br />
* '''authorized''': State of authkey. It's false at this moment.<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden: sharedkey or signature are not valid<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/createauth<br />
?sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=9c47b45a87e02624bb7b98b96f5f147e22ecc592<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"authkey":"c498d3e0-aedb-48fe-82d5-5dec4270318b",<br />
"authorized":"false"<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Certificates&diff=31Certificates2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation lists the certificates of the authorizing user.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/certificates</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authorization key<br />
* '''type''': Type of certificate to search <br />
** ''web_static'' Static web pages<br />
** ''web_snapshots'' Web browsing sessions with snapshots<br />
** ''web_video'' Web browsing sessions with video<br />
** ''web'' Web certificates, includes ''web_static'', ''web_snapshots'' and ''web_video'' certificates<br />
** ''mail'' E-mail certificates<br />
** ''photo'' Geo-located photographs<br />
** ''file'' Files<br />
* '''fromDate''': Return certificates generated from this date on (optional, format yyyy-MM-dd)<br />
* '''toDate''': Return certificates generated up to this date (optional, format yyyy-MM-dd)<br />
* '''filter''': Text for searching certificates (optional)<br />
* '''page''': Page number to return (optional, defaults to 1)<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''pageSize''': Maximum number of certificates per page<br />
* '''count''': Total number of certificates<br />
* '''pageTotal''': Total number of pages <br />
* '''list''': array of JSON with the certificates data<br />
** '''entryDate''': Date of certificate<br />
** '''code''': Certificate code<br />
** '''url''': Public URL for certificate download<br />
** '''thumbnailUrl''': URL of thumbnail of certificate (optional, just for web and photo certificates)<br />
** '''properties''': JSON with the properties of the certificate<br />
*** Web certificates<br />
**** '''url''': URL that was certified <br />
*** Mail certificates<br />
**** '''toAddresses''': E-mail destinataries<br />
**** '''subject''': Subject of e-mail<br />
*** Photo certificates<br />
**** '''latitude''': Latitude where the photo was taken<br />
**** '''longitude''': Longitude where the photo was taken<br />
**** '''accuracy''': Accuracy of geographic location, in meters<br />
**** '''address''': Human-readable photo location<br />
*** File certificates<br />
**** '''filename''': File name <br />
**** '''size''': Size of file<br />
**** '''md5''': MD5 hash of file<br />
**** '''sha1''': SHA1 hash of file<br />
**** '''sha256''': SHA256 hash of file<br />
**** '''sha512''': SHA512 hash of file<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
* '''401''' Unauthorized: authkey is not valid or not authorized<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/certificates<br />
?authkey=0dbb406d-cc0c-4ef8-ae80-971ed108c2f9<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&type=web<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"pageSize":50,<br />
"count":1, <br />
"pageTotal":1,<br />
"list":[<br />
{<br />
"entryDate":"2016-11-11T12:59:36Z",<br />
"code":"161111-8CM65B",<br />
"url":"http://dev.safestamper.com:9001/certificate/161111-8CM65B",<br />
"thumbnailUrl":"https://pagestamper-dev.s3.amazonaws.com/16/11/11/161111-8CM65B.png?AWSAccessKeyId\u003dAKIAI2GFJVQOFPVV5SZA\u0026Expires\u003d1480695450\u0026Signature\u003dL7TBOPa6gKVS5OTGASfq68XMxGk%3D",<br />
"properties":{"url":"https://informaticaglobaldariomo.blogspot.com.es/2016/08/startup-manager-una-aplicacion-android.html"}<br />
}<br />
]<br />
}<br />
</pre></div>Adminwikihttps://wiki.safestamper.com/index.php?title=Certificate/tag&diff=29Certificate/tag2023-10-17T11:27:27Z<p>Adminwiki: 1 revision imported</p>
<hr />
<div>This operation set tag to certificate<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/certificate/tag</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey of certificate owner<br />
* '''code''': Code of certificate to modify<br />
* '''tag''': Tag to save in the certificate<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
HTTP 200 OK<br />
<br />
= HTTP Errors =<br />
<br />
* '''401''' Unauthorized: the authkey is not exist<br />
* '''403''' Forbidden: the sharedkey or signature are not valid<br />
* '''404''' Not found: the certificate does not exist<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/certificate/tag<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&code=150121-6MY3TJ<br />
&tag=Test<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77<br />
</pre><br />
<br />
RESPONSE:<br />
<br />
HTTP 200 OK</div>Adminwiki