The REST interface offered by SWS is exposed at the path:
http://<IP-APPLIANCE>:8080/SignEngineWeb/rest/ |
This path is composed by other sub-path for every of purpose:
And in this guide will be described how manage the error generated by the REST interface.
NOTE: this interface is available from SWS version: 2.5.52
SWS rest interface use this convention for create the response
Request is CORRECT, will return response code 200 with response body (if present) . Like in this example:
Request NOT-CORRECT with error managed, will return response code 400 and the header will have the field "errorMsg" with error description (in Italian) and field "errorCode" with code error. Like in this example:
NOTE: if you want the "errorMsg" in a specified language, you can use the method "enquiry/erros" will be described in the next section.
Description | return the certifcate associated to "device_signer" | |
HttpMethod | POST | |
---|---|---|
Path | /rest/enquiry/certificate | |
Request |
| |
Response | return the byte array of certificate associated to device_signer |
Description | return the numer of signatures apposed from "device_signer" | |
HttpMethod | POST | |
---|---|---|
Path | /rest/enquiry/signatures | |
Request |
| |
Response | Number of signatures apposed |
Description | return the number of signatures which "device_signer" can apply | |
HttpMethod | POST | |
---|---|---|
Path | /rest/enquiry/signatures-available | |
Request |
| |
Response | Number of signatures available |
Description | return the otp list associated to "device_signer" | |
HttpMethod | POST | |
---|---|---|
Path | /rest/enquiry/otps | |
Request |
| |
Response |
|
Description | return the numeber of timestamp available (valid only for Namirial TSA account) | |
HttpMethod | POST | |
---|---|---|
Path | /rest/enquiry/timestamps-available | |
Request |
| |
Response | Number of timestamps available |
Description | return the error description associated to error code | |
HttpMethod | POST | |
---|---|---|
Path | /rest/enquiry/errors | |
Request |
| |
Response |
|
Description | remove the certificate from cache of SWS | |
HttpMethod | PUT | |
---|---|---|
Path | /rest/admin/remove-certificate-from-cache | |
Request |
| |
Response |
Description | permits to apply timestamp on specified file | |
HttpMethod | POST | |
---|---|---|
Path | /rest/timestamps/apply | |
Request | ||
timeStampPreferences |
| |
content | file to apply timestamp | |
Response |
Description | permits to change the password associated to device signer | |
HttpMethod | POST | |
---|---|---|
Path | /rest/user/change-password | |
Request (for remote device signer) |
| |
Request (for automatic device signer) |
| |
Response | Password update succesfully |
Description | permits to open the sessione for apply multiple sign with remote device | |
HttpMethod | POST | |
---|---|---|
Path | /rest/sign/openSession | |
Request |
| |
Response | String with the session |
Description | permits to obtain the time until the session is valid | |
HttpMethod | POST | |
---|---|---|
Path | /rest/sign/getRemainingTimeForSession | |
Request |
| |
Response | Seconds until the session is valid |
Description | permits to destroy the session before will expire | |
HttpMethod | POST | |
---|---|---|
Path | /rest/sign/closeSession | |
Request |
| |
Response |
Description | permits to destroy the session before will expire | |
HttpMethod | POST | |
---|---|---|
Path | /rest/sign/sendOtpBySMS | |
Request |
| |
Response |
Description | permits to apply the cades signature | |
HttpMethod | POST | |
---|---|---|
Path | /rest/sign/signCades | |
Request | ||
credentials |
| |
cadesPreferences |
| |
content | file to sign | |
Response | byte array of signed files |
Description | permits to apply the pades signature | |
HttpMethod | POST | |
---|---|---|
Path | /rest/sign/signPades | |
Request | ||
credentials |
| |
padesPreferences |
| |
image | file with image (of appereance) | |
content | PDF file to sign | |
Response | byte array of signed files |
Description | permits to apply the pades signature | |
HttpMethod | POST | |
---|---|---|
Path | /rest/sign/signXades | |
Request | ||
credentials |
| |
xadesPreferences |
| |
content | XML file to sign | |
Response | byte array of signed files |
Description | permits to apply the pades signature | |
HttpMethod | POST | |
---|---|---|
Path | /rest/sign/signPKCS1 | |
Request | ||
credentials |
| |
signPreferences |
| |
buffer | hash to sign | |
Response | byte array associated to hash signed |