Skip to end of metadata
Go to start of metadata
You are viewing an old version of this content. View the current version.
Compare with Current
View Version History
« Previous
Version 12
Next »
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: certificate
| Description | return the certifcate associated to "device_signer" |
| HttpMethod | POST |
|---|
| Path | /rest/enquiry/certificate |
| Request | request-enquiry-certificate {
"credentials": {
"username": "device_signer"
}
} |
| Response |
|
ENQUIRY: signatures
| Description | return the numer of signatures apposed from "device_signer" |
| HttpMethod | POST |
|---|
| Path | |
| Request | request-enquiry-signatures {
"credentials": {
"username": "device_signer"
}
} |
| Response |
|
ENQUIRY: signatures/available
| Description | return the number of signatures which "device_signer" can apply |
| HttpMethod | POST |
|---|
| Path | /rest/enquiry/signatures/available |
| Request | request-enquiry-signatures-available {
"credentials": {
"username": "device_signer"
}
} |
| Response |
|
ENQUIRY: otps
| Description | return the otp list associated to "device_signer" |
| HttpMethod | POST |
|---|
| Path | |
| Request | request-enquiry-otps {
"credentials": {
"username": "device_signer"
}
} |
| 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 | request-enquiry-certificate {
TO FILL
}
} |
| Response |
|
ENQUIRY: errors
| Description | return the error description associated to error code |
| HttpMethod | POST |
|---|
| Path | |
| Request | request-enquiry-errors {
TO FILL
}
} |
| Response |
|
ADMIN: remove-certificate-from-cache
| Description | remove the certificate from cache of SWS |
| HttpMethod | PUT |
|---|
| Path | /rest/admin/remove-certificate-from-cache |
| Request | request-enquiry-remove-certificate-from-cache {
"credentials": {
"username": "device_signer"
}
} |
TIMESTAMPS: apply
| Description | permits to apply timestamp on specified file |
| HttpMethod | POST |
|---|
| Path | |
| Request | request-timestamps-apply {
TO FILL
}
} |
| Response |
|
USER: change-password
| Description | permits to change the password associated to device signer |
| HttpMethod | POST |
|---|
| Path | /rest/user/change-password |
| Request | request-user-change-password {
TO FILL
}
} |
| Response |
|
SIGN: openSession
| Description | permits to open the sessione for apply multiple sign with remote device |
| HttpMethod | POST |
|---|
| Path | |
| Request | request-sign-openSession {
TO FILL
}
} |
| Response |
|
SIGN: closeSession
| Description | permits to destroy the session |
| HttpMethod | POST |
|---|
| Path | |
| Request | request-sign-closeSession {
TO FILL
}
} |
| Response |
|