Introduction
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:
- admin: method for sws like remove certificate from cache
- enquiry: contain the method for obtain the information like signatures available, signer certificate, timestamps available ecc...
- sign: this is the principal path of SWS and contain the methods for apply the signature
- timestamps: methods for apply the timestamp on every type of file
And in this guid will be described how manage the error generated by the REST interface.
Enquiry
ENQUIRY: certificate
| Description | return the certifcate associated to "device_signer" | |
| HttpMethod | POST | |
|---|---|---|
| Path | /rest/enquiry/certificate | |
| Request |
| |
| Response |
ENQUIRY: signatures
| Description | return the numer of signatures apposed from "device_signer" | |
| HttpMethod | POST | |
|---|---|---|
| Path | /rest/enquiry/signatures | |
| Request |
| |
| Response |
ENQUIRY: signatures/available
| Description | return the number of signatures which "device_signer" can apply | |
| HttpMethod | POST | |
|---|---|---|
| Path | /rest/enquiry/signatures/available | |
| Request |
| |
| Response |
ENQUIRY: otps
| Description | return the otp list associated to "device_signer" | |
| HttpMethod | POST | |
|---|---|---|
| Path | /rest/enquiry/otps | |
| Request |
| |
| Response |
ENQUIRY: timestamps/available
| Description | return the numeber of timestamp available (valid only for Namirial TSA account) | |
| HttpMethod | POST | |
|---|---|---|
| Path | /rest/enquiryt/timestamps/available | |
| Request |
| |
| Response |
ENQUIRY: errors
| Description | return the error description associated to error code | |
| HttpMethod | POST | |
|---|---|---|
| Path | /rest/enquiryt/errors | |
| Request |
| |
| Response |
Admin
ADMIN: remove-certificate-from-cache
| Description | remove the certificate from cache of SWS | |
| HttpMethod | PUT | |
|---|---|---|
| Path | /rest/admin/remove-certificate-from-cache | |
| Request |
|
Timestamps
TIMESTAMPS: apply
| Description | permits to apply timestamp on specified file | |
| HttpMethod | POST | |
|---|---|---|
| Path | /rest/timestamps/apply | |
| Request |
| |
| Response |
User
USER: change-password
| Description | permits to change the password associated to device signer | |
| HttpMethod | POST | |
|---|---|---|
| Path | /rest/user/change-password | |
| Request |
| |
| Response |
Sign
SIGN: openSession
| Description | permits to open the sessione for apply multiple sign with remote device | |
| HttpMethod | POST | |
|---|---|---|
| Path | /rest/sign/openSession | |
| Request |
| |
| Response |
SIGN: closeSession
| Description | permits to destroy the session | |
| HttpMethod | POST | |
|---|---|---|
| Path | /rest/sign/openSession | |
| Request |
| |
| Response |