Signature/status and Signature/tag: Difference between pages

From SafeStamper API documentation
(Difference between pages)
Jump to navigation Jump to search
m (1 revision imported)
 
api>Admin
No edit summary
 
Line 1: Line 1:
Returns the status of a document signature.
This operation set tag to document


= URL =
= URL =
<nowiki>https://www.safestamper.com/api/signature/status</nowiki>
<nowiki>https://www.safestamper.com/api/signature/tag</nowiki>


= Parameters =
= Parameters =
* '''sharedkey''': Your API client shared key
* '''sharedkey''': Your API client shared key
* '''authkey''': Authorization key, if needed
* '''authkey''': Authkey of document owner
* '''code''': Document code, returned by [[signature/sign]]
* '''code''': Code of document to modify
* '''tag''': Tag to save in the document
* '''signature''': Parameters signature, as explained in [[Signature parameter]]
* '''signature''': Parameters signature, as explained in [[Signature parameter]]


= Returns =
= Returns =


A JSON object with the following fields:
HTTP 200 OK
 
* '''code''': Document code
* '''title''': Document title
* '''senderName''': Sender name
* '''senderEmail''': Sender e-mail address
* '''entryDate''': Date of upload
* '''state''': Document state
** '''PENDING''': The document doesn't have all its signatures
** '''SIGNED''': The document has all its signatures and it has generated a signing certificate
* '''certificateCode''': Code of the signature certificate, if it has already been generated (for SIGNED documents)
* '''certificateUrl''': Validation URL of the signature certificate, if it has already been generated (for SIGNED documents)
** 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.
* '''signatures''': The list of signatures
** '''signerName''': Signer name
** '''signerEmail''': Signer e-mail address
** '''state''': Signature state
*** '''PENDING''': The signer has not answered yet
*** '''SIGNED''': The signer has signed the document
** '''signerIP''': IP address from which the document was signed
** '''signatureDate''': Date of signature
 


= HTTP Errors =
= HTTP Errors =


* '''403''' Forbidden, the sharedkey or parameter signature are not valid
* '''401''' Unauthorized: the authkey is not exist
* '''401''' Unauthorized, the authkey is not valid  
* '''403''' Forbidden: the sharedkey or signature are not valid
* '''404''' Document code not found
* '''404''' Not found: the notification does not exist


= Example =
= Example =
Line 45: Line 25:
REQUEST:
REQUEST:
<pre>
<pre>
https://www.safestamper.com/api/signature/sign
https://www.safestamper.com/api/signature/tag
?sharedkey=5hmpod0d2vx7fnh6ysxab3olz
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec
&code=b508e6e9-e5f6-4bb5-beef-c89bf6b50764
&code=b508e6e9-e5f6-4bb5-beef-c89bf6b50764
&signature=6e83ffc1db2ea262c71426f2660882539d40ec60
&tag=Test
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77
</pre>
</pre>


RESPONSE:
RESPONSE:
<pre>
 
{
HTTP 200 OK
  "code":"b508e6e9-e5f6-4bb5-beef-c89bf6b50764",
  "title":"Test Document",
  "senderName":"John Doe",
  "senderEmail":"john@example.com",
  "state":"PENDING",
  "entryDate":"2019-07-29T09:18:46Z",
  "signatures":[
    {
      "signerName":"Anne Example",
      "signerEmail":"anne@example.com",
      "signerIP":"127.0.0.1",
      "state":"SIGNED",
      "signatureDate":"2019-07-29T09:32:41Z"
    },
    {
      "signerName":"Bernie Beans",
      "signerEmail":"bernie@example.com",
      "state":"PENDING"
    }
  ]
}
</pre>

Revision as of 13:52, 4 October 2022

This operation set tag to document

URL

https://www.safestamper.com/api/signature/tag

Parameters

  • sharedkey: Your API client shared key
  • authkey: Authkey of document owner
  • code: Code of document to modify
  • tag: Tag to save in the document
  • signature: Parameters signature, as explained in Signature parameter

Returns

HTTP 200 OK

HTTP Errors

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

Example

REQUEST: 

https://www.safestamper.com/api/signature/tag
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec
&code=b508e6e9-e5f6-4bb5-beef-c89bf6b50764
&tag=Test
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77

RESPONSE:

HTTP 200 OK

Retrieved from "https://wiki.safestamper.com/index.php?title=Signature/status&oldid=90"