Versions Compared

Version Old Version 81 New Version Current
Changes made by

Lorenzo Cardinali

Lorenzo Cardinali

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

The REST interface offered by SWS is exposed at the path:

Code Block
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 guide will be described how manage the error generated by the REST interface.

NOTE: this interface is available from SWS version: 2.5.52

Convention (manage the response)

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:

Image Removed

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:

Image Removed

NOTE: if you want the "errorMsg" in a specified language, you can use the method "enquiry/errors" will be described in the next section.

Enquiry

ENQUIRY: certificate

Descriptionreturn the certifcate associated to "device_signer"HttpMethodPOSTPath
/enquiry/certificate
Request
Expand
titlerequest-enquiry-certificate
{
  "credentials": {
    "username": "device_signer"
  }
}
Responsereturn the byte array of certificate associated to device_signer

ENQUIRY: signatures

Descriptionreturn the numer of signatures apposed from "device_signer"HttpMethodPOSTPath
/enquiry/signatures
Request
Expand
titlerequest-enquiry-signatures
{
  "credentials": {
    "username": "device_signer"
  }
}
ResponseNumber of signatures apposed

ENQUIRY: signatures-available

Descriptionreturn the number of signatures which "device_signer" can applyHttpMethodPOSTPath
/enquiry/signatures-available
Request
Expand
titlerequest-enquiry-signatures-available
{
  "credentials": {
    "username": "device_signer"
  }
}
ResponseNumber of signatures available

ENQUIRY: otps

Descriptionreturn the otp list associated to "device_signer"HttpMethodPOSTPath
/enquiry/otps
Request
Expand
titlerequest-enquiry-otps
{
  "credentials": {
    "username": "device_signer"
  }
}
Response
Expand
titleresponse-enquiry-otps

[
    {
        "idOtp": number,
        "serialNumber": "string",
        "type": "otp-type-enum"
    },
   {
        "idOtp": number,
        "serialNumber": "string",
        "type": "otp-type-enum"
    }
]

ENQUIRY: timestamps-available

Descriptionreturn the numeber of timestamp available (valid only for Namirial TSA account)HttpMethodPOSTPath
/enquiry/timestamps-available
Request
Expand
titlerequest-enquiry-timestamps-available

{
  "timestampUrl": "timestamp-namirial-enquiry-url",
  "timestampUsername": "tsa-username",
  "timestampPassword": "tsa-password"
}

ResponseNumber of timestamps available

ENQUIRY: errors

Descriptionreturn the error description associated to error codeHttpMethodPOSTPath
/enquiry/errors
Request
Expand
titlerequest-enquiry-errors

{
  "error_code": integer,
  "lang": "COUNTRY-CODE-2DIGIT"
}

Response
Expand
languagejs
titleresponse-enquiry-errors
collapsetrue

[
    {
        "errorCode": integer,
        "errorLanguage": "CONUNTRY-CODE-2DIGIT",
        "errorLanguage2": "COUNTRY-CODE-3DIGIT",
        "errorText": "Description error in language"
    }
]

ENQUIRY: all-signature-fields-with-preferences

Descriptionreturn a list of SignatureFieldNameHttpMethodPOSTPath
/enquiry/all-signature-fields-with-preferences
Header

Content-Type = multipart/form-data

Accept = application/json

Requestpreferences
Code Block
languagejs
{
    "withDetails": boolean,
    "withCertificate": boolean,
    "encryptionPassword": string
}
bufferPDF file to extract fieldResponse
Code Block
languagejs
[
    {
        "identifier": string,
        "signatureDetails": {
            "name": string,
            "signDate": unixtime,
            "location": string,
            "reason": string,
            "page": integer,
            "appearance": {
                "width": float,
                "height": float,
                "x": float,
                "y": float
            },
            "certificate": "<base64-encoded certificate>",
            "subjectDN": "string"
        },
        "signed": boolean
    },
	...
]

ENQUIRY: available-signature-fields

Descriptionreturn a list with name of signature fieldHttpMethodPOSTPath
/enquiry/available-signature-fields
Header

Content-Type = multipart/form-data

Accept = application/json

RequestbufferPDF file to extract fieldencryptionPasswordpassword to open PDF if presentResponse
Code Block
languagejs
[
    "FieldName-1",
    "FieldName-2",
	...
]

Admin

ADMIN: remove-certificate-from-cache

Descriptionremove the certificate from cache of SWSHttpMethodPUTPath
/admin/remove-certificate-from-cache
Request
Expand
titlerequest-enquiry-remove-certificate-from-cache

{
  "error_code": integer,
  "lang": "COUNTRY-CODE-2DIGIT"
}

Response

Timestamps

TIMESTAMPS: apply

Descriptionpermits to apply timestamp on specified fileHttpMethodPOSTPath
/timestamps/apply
RequesttimestampPreferences
Expand
titlerequest-timestamps-apply

{
  "filenameInTSD": "string",
  "outputAsPDF": boolean,
  "outputAsTSD": boolean,
  "outputBase64Encoded": boolean,
  "timestampHashAlgo": "string",
  "timestampPassword": "string",
  "timestampUrl": "string",
  "timestampUsername": "string"
}

contentfile to apply timestampResponse

User

USER: change-password

Descriptionpermits to change the password associated to device signerHttpMethodPOSTPath
/user/change-password
Request (for remote device signer)
Expand
titlerequest-user-change-password-remote

{
  "credentials": {
    "idOtp": idOtp or -1,
    "otp": "otpCode",
    "password": "old-password-of-device-signer-remote",
    "username": "device-signer-remote"
  },
  "newPassword": "new-password-of-device-signer-remote"
}

Request (for automatic device signer)
Expand
titlerequest-user-change-password-automatic

{
  "credentials": {
    "securityCode": "securityCode associate to automatic device signer",
    "password": "old-password-of-device-signer-automatic",
    "username": "device-signer-automatic"
  },
  "newPassword": "new-password-of-device-signer-automatic"
}

ResponsePassword update succesfully

Sign

SIGN: openSession

Descriptionpermits to open the sessione for apply multiple sign with remote deviceHttpMethodPOSTPath
/sign/openSession
Request
Expand
titlerequest-sign-openSession

{
  "credentials": {
    "idOtp": -1,
    "otp": "775351",
    "password": "12345678",
    "username": "RHIP22021116852552"
  }
}

ResponseString with the session

SIGN: getRemainingTimeForSession

Descriptionpermits to obtain the time until the session is validHttpMethodPOSTPath
/sign/getRemainingTimeForSession
Request
Expand
titlerequest-sign-getRemainingTimeForSession

{
  "credentials": {
    "sessionKey": "zZto1G0DpL/vBFkTnK7caquzY5pasOlzS+bQG7wUkOONnbV7Vhd+JSPTjP7ZqTYR12QjS0W89T7UmnQB2KzAQ3C4NalDgFE67ntqoGm7uOU7+oOPLvKQv/p5aeZ2bcjKe6x5KQPUEH//rKaExFcLcLj8cnwXfFBixJ4MN+3o8S5535HcRxWv+YoTHHgAY16Fh0yJGfLL3x/4W+HJeiIYL2cHpKNTGkKcGTM8Eon0R+djNFvKzZSF1VIETPADqDdvgLYkRWODd3yoUvExGk5BcQKVm0Z7Nd7NMKl4NRbHumdqmqy81jchQv2qlXIxSpjZ0GTnL4vDZMF2MP2DGHPoWw==",
    "username": "RHIP22021116852552"
  }
}

ResponseSeconds until the session is valid

SIGN: closeSession

Descriptionpermits to destroy the session before will expireHttpMethodPOSTPath
/sign/closeSession
Request
Expand
titlerequest-sign-closeSession

{
  "credentials": {
    "sessionKey": "zZto1G0DpL/vBFkTnK7caquzY5pasOlzS+bQG7wUkOONnbV7Vhd+JSPTjP7ZqTYR12QjS0W89T7UmnQB2KzAQ3C4NalDgFE67ntqoGm7uOU7+oOPLvKQv/p5aeZ2bcjKe6x5KQPUEH//rKaExFcLcLj8cnwXfFBixJ4MN+3o8S5535HcRxWv+YoTHHgAY16Fh0yJGfLL3x/4W+HJeiIYL2cHpKNTGkKcGTM8Eon0R+djNFvKzZSF1VIETPADqDdvgLYkRWODd3yoUvExGk5BcQKVm0Z7Nd7NMKl4NRbHumdqmqy81jchQv2qlXIxSpjZ0GTnL4vDZMF2MP2DGHPoWw==",
    "username": "RHIP22021116852552"
  }
}

Response

SIGN: sendOtpBySMS

Descriptionpermits to destroy the session before will expireHttpMethodPOSTPath
/sign/sendOtpBySMS
Request
Expand
titlerequest-sign-sendOtpBySMS

{
  "credentials": {
    "username": "RHIP22021116852552"
  }
}

Response

SIGN: signCades

Descriptionpermits to apply the cades

Table of Contents

Introduction


The REST interface offered by SWS is exposed at the path:

Code Block
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 guide will be described how manage the error generated by the REST interface.



NOTE: this interface is available from SWS version: 2.5.52

Convention (manage the response)


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:

Image Added


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:

Image Added

NOTE: if you want the "errorMsg" in a specified language, you can use the method "enquiry/errors" will be described in the next section.













Enquiry

ENQUIRY: certificate


Descriptionreturn the certifcate associated to "device_signer"
HttpMethodPOST
Path
/enquiry/certificate
Request


Expand
titlerequest-enquiry-certificate
{
  "credentials": {
    "username": "device_signer"
  }
}


Responsereturn the byte array of certificate associated to device_signer


ENQUIRY: signatures


Descriptionreturn the numer of signatures apposed from "device_signer"
HttpMethodPOST
Path
/enquiry/signatures
Request


Expand
titlerequest-enquiry-signatures
{
  "credentials": {
    "username": "device_signer"
  }
}


ResponseNumber of signatures apposed



ENQUIRY: signatures-available


Descriptionreturn the number of signatures which "device_signer" can apply
HttpMethodPOST
Path
/enquiry/signatures-available
Request


Expand
titlerequest-enquiry-signatures-available
{
  "credentials": {
    "username": "device_signer"
  }
}


ResponseNumber of signatures available



ENQUIRY: otps


Descriptionreturn the otp list associated to "device_signer"
HttpMethodPOST
Path
/enquiry/otps
Request


Expand
titlerequest-enquiry-otps
{
  "credentials": {
    "username": "device_signer"
  }
}


Response


Expand
titleresponse-enquiry-otps

[
    {
        "idOtp": number,
        "serialNumber": "string",
        "type": "otp-type-enum"
    },
   {
        "idOtp": number,
        "serialNumber": "string",
        "type": "otp-type-enum"
    }
]




ENQUIRY: timestamps-available


Descriptionreturn the numeber of timestamp available (valid only for Namirial TSA account)
HttpMethodPOST
Path
/enquiry/timestamps-available
Request


Expand
titlerequest-enquiry-timestamps-available

{
  "timestampUrl": "timestamp-namirial-enquiry-url",
  "timestampUsername": "tsa-username",
  "timestampPassword": "tsa-password"
}


ResponseNumber of timestamps available


ENQUIRY: errors


Descriptionreturn the error description associated to error code
HttpMethodPOST
Path
/enquiry/errors
Request


Expand
titlerequest-enquiry-errors

{
  "error_code": integer,
  "lang": "COUNTRY-CODE-2DIGIT"
}


Response


Expand
languagejs
titleresponse-enquiry-errors
collapsetrue

[
    {
        "errorCode": integer,
        "errorLanguage": "CONUNTRY-CODE-2DIGIT",
        "errorLanguage2": "COUNTRY-CODE-3DIGIT",
        "errorText": "Description error in language"
    }
]



ENQUIRY: all-signature-fields-with-preferences


Descriptionreturn a list of SignatureFieldName
HttpMethodPOST
Path
/enquiry/all-signature-fields-with-preferences
Header

Content-Type = multipart/form-data

Accept = application/json

Request



preferences


Code Block
languagejs
{
    "withDetails": boolean,
    "withCertificate": boolean,
    "encryptionPassword": string
}


bufferPDF file to extract field
Response


Code Block
languagejs
[
    {
        "identifier": string,
        "signatureDetails": {
            "name": string,
            "signDate": unixtime,
            "location": string,
            "reason": string,
            "page": integer,
            "appearance": {
                "width": float,
                "height": float,
                "x": float,
                "y": float
            },
            "certificate": "<base64-encoded certificate>",
            "subjectDN": "string"
        },
        "signed": boolean
    },
	...
]



ENQUIRY: available-signature-fields


Descriptionreturn a list with name of signature field
HttpMethodPOST
Path
/enquiry/available-signature-fields
Header

Content-Type = multipart/form-data

Accept = application/json

Request



bufferPDF file to extract field
encryptionPasswordpassword to open PDF if present
Response


Code Block
languagejs
[
    "FieldName-1",
    "FieldName-2",
	...
]



ENQUIRY: devices


Descriptionreturn a list with device name belong to a private area user (MyNamirial account)
HttpMethodGET
Path
/enquiry/device
Header

Accept = application/json

Request (queryParam)



usernamethe username of private area user
Response


Code Block
languagejs
{
"devices": [
	{
		"name": "RHI........",
		"type": "REMOTE"
	},
	{
		"name": "RHI.....",
		"type": "REMOTE"
	}
]
}



Admin

ADMIN: remove-certificate-from-cache


Descriptionremove the certificate from cache of SWS
HttpMethodPUT
Path
/admin/remove-certificate-from-cache
Request


Expand
titlerequest-enquiry-remove-certificate-from-cache

{
  "error_code": integer,
  "lang": "COUNTRY-CODE-2DIGIT"
}


Response


Timestamps

TIMESTAMPS: apply

Descriptionpermits to apply timestamp on specified file
HttpMethodPOST
Path
/timestamps/apply
Request
timestampPreferences


Expand
titlerequest-timestamps-apply

{
  "filenameInTSD": "string",
  "outputAsPDF": boolean,
  "outputAsTSD": boolean,
  "outputBase64Encoded": boolean,
  "timestampHashAlgo": "string",
  "timestampPassword": "string",
  "timestampUrl": "string",
  "timestampUsername": "string"
}


contentfile to apply timestamp


Response


User

USER: change-password

Descriptionpermits to change the password associated to device signer
HttpMethodPOST
Path
/user/change-password
Request (for remote device signer)


Expand
titlerequest-user-change-password-remote

{
  "credentials": {
    "idOtp": idOtp or -1,
    "otp": "otpCode",
    "password": "old-password-of-device-signer-remote",
    "username": "device-signer-remote"
  },
  "newPassword": "new-password-of-device-signer-remote"
}


Request (for automatic device signer)


Expand
titlerequest-user-change-password-automatic

{
  "credentials": {
    "securityCode": "securityCode associate to automatic device signer",
    "password": "old-password-of-device-signer-automatic",
    "username": "device-signer-automatic"
  },
  "newPassword": "new-password-of-device-signer-automatic"
}


ResponsePassword update succesfully


Sign

SIGN: openSession


Descriptionpermits to open the sessione for apply multiple sign with remote device
HttpMethodPOST
Path
/sign/openSession
Request


Expand
titlerequest-sign-openSession

{
  "credentials": {
    "idOtp": -1,
    "otp": "775351",
    "password": "12345678",
    "username": "RHIP22021116852552"
  }
}


ResponseString with the session


SIGN: getRemainingTimeForSession


Descriptionpermits to obtain the time until the session is valid
HttpMethodPOST
Path
/sign/getRemainingTimeForSession
Request


Expand
titlerequest-sign-getRemainingTimeForSession

{
  "credentials": {
    "sessionKey": "zZto1G0DpL/vBFkTnK7caquzY5pasOlzS+bQG7wUkOONnbV7Vhd+JSPTjP7ZqTYR12QjS0W89T7UmnQB2KzAQ3C4NalDgFE67ntqoGm7uOU7+oOPLvKQv/p5aeZ2bcjKe6x5KQPUEH//rKaExFcLcLj8cnwXfFBixJ4MN+3o8S5535HcRxWv+YoTHHgAY16Fh0yJGfLL3x/4W+HJeiIYL2cHpKNTGkKcGTM8Eon0R+djNFvKzZSF1VIETPADqDdvgLYkRWODd3yoUvExGk5BcQKVm0Z7Nd7NMKl4NRbHumdqmqy81jchQv2qlXIxSpjZ0GTnL4vDZMF2MP2DGHPoWw==",
    "username": "RHIP22021116852552"
  }
}


ResponseSeconds until the session is valid


SIGN: closeSession


Descriptionpermits to destroy the session before will expire
HttpMethodPOST
Path
/sign/closeSession
Request


Expand
titlerequest-sign-closeSession

{
  "credentials": {
    "sessionKey": "zZto1G0DpL/vBFkTnK7caquzY5pasOlzS+bQG7wUkOONnbV7Vhd+JSPTjP7ZqTYR12QjS0W89T7UmnQB2KzAQ3C4NalDgFE67ntqoGm7uOU7+oOPLvKQv/p5aeZ2bcjKe6x5KQPUEH//rKaExFcLcLj8cnwXfFBixJ4MN+3o8S5535HcRxWv+YoTHHgAY16Fh0yJGfLL3x/4W+HJeiIYL2cHpKNTGkKcGTM8Eon0R+djNFvKzZSF1VIETPADqDdvgLYkRWODd3yoUvExGk5BcQKVm0Z7Nd7NMKl4NRbHumdqmqy81jchQv2qlXIxSpjZ0GTnL4vDZMF2MP2DGHPoWw==",
    "username": "RHIP22021116852552"
  }
}


Response


SIGN: sendOtpBySMS


Descriptionpermits to destroy the session before will expire
HttpMethodPOST
Path
/sign/sendOtpBySMS
Request


Expand
titlerequest-sign-sendOtpBySMS

{
  "credentials": {
    "username": "RHIP22021116852552"
  }
}


Response


SIGN: signCades


Descriptionpermits to apply the cades signature
HttpMethodPOST
Path
/sign/signCades
Request
credentials


Expand
titlerequest-signCades-credentials

{

"username":"device signer name",

"password":"PIN of device signer name",

"idOtp":associated to device signer or -1,

"otp":"otp code",

"sessionKey":"string with sessionKey"

}


cadesPreferences


Expand
titlerequest-signCades-cadesPrefernces

{
  "filenameInTSD": "string",
  "outputAsPDF": boolean,
  "outputAsTSD": boolean,
  "outputBase64Encoded": boolean,
  "timestampHashAlgo": "string",
  "timestampPassword": "string",
  "timestampUrl": "string",
  "timestampUsername": "string",
  "hashAlgorithm": "string",
  "level": "enum",
  "withTimestamp": boolean,
  "counterSignature": true,
  "counterSignatureIndex": 0,
  "detached": boolean
}


bufferfile to sign
Responsebyte array of signed files



SIGN: signCades (detached output p7s)


If you want make the Cades detached signature, SWS not require all files to sign, but only the hash. The tag "buffer" will be the hash of the file.

For example if we want the cades detached signature of this PDF the procedure is:

Calculate the hash of this file, for example with the openssl:

Code Block
openssl dgst -sha256 -binary FILE_TO_BE_SIGN | openssl enc -a

And in output will obtain the hash to sign, will be:

Code Block
HASH TO SIGN = msj3f4hJCSELbMkWjkFwNrf0XhkebTnAKaKhx4686DY=

Now you can decode this string and will be the input relates to field "buffer"

This string "msj.....DY=" decoded will be the "buffer" on REST signCades like this file (this it the byte array to sign)


Descriptionpermits to obtain the cades detached signature (p7s) , from the hash associated to the file to sign
HttpMethodPOST
Path
/sign/signCades
Request
credentials


Expand
titlerequest-signCades-credentials

{

"username":"device signer name",

"password":"PIN of device signer name",

"idOtp":associated to device signer or -1,

"otp":"otp code",

"sessionKey":"string with sessionKey"

}


cadesPreferences


Expand
titlerequest-signCades-cadesPrefernces

{"detached": true}


buffer

btye array relates to the hash files to sign

Responsebyte array related to sign of the hash and the certificate associate


REST RESPONSE:

In output will obtain the hash signed and the certificate associated to the private key which has signed the hash, the response will be this


SIGN: signPades

In output will obtain the hash signed and the certificate associated to the private key which has signed the hash, the response will be this

SIGN: signPades
Descriptionpermits to apply the pades signature
HttpMethodPOST
Path
/sign/signCadessignPades
Request
credentials


Expand
titlerequest-signCadessignPades-credentials

{

"username":"device signer name",

"password":"PIN of device signer name",

"idOtp":associated to device signer or -1,

"otp":"otp code",

"sessionKey":"string with sessionKey"

}


cadesPreferencespadesPreferences


Expand
titlerequest-signCadessignPades-cadesPreferncespadesPreferences

{
  "filenameInTSD": "string",
  "outputAsPDF": boolean,
  "outputAsTSD": boolean,
  "outputBase64Encoded": boolean,
  "timestampHashAlgo": "string",
  "timestampPassword": "string",
  "timestampUrl": "string",
  "timestampUsername": "string",
  "hashAlgorithm": "string",
  "level": "enum",
  "withTimestamp": boolean,
  "counterSignature": true,
  "counterSignatureIndex": 0,
  "detached": boolean
}

bufferfile to sign
Responsebyte array of signed files

SIGN: signCades (detached output p7s)

If you want make the Cades detached signature, SWS not require all files to sign, but only the hash. The tag "buffer" will be the hash of the file.

For example if we want the cades detached signature of this PDF the procedure is:

Calculate the hash of this file, for example with the openssl:

Code Block
openssl dgst -sha256 -binary FILE_TO_BE_SIGN | openssl enc -a

And in output will obtain the hash to sign, will be:

Code Block
HASH TO SIGN = msj3f4hJCSELbMkWjkFwNrf0XhkebTnAKaKhx4686DY=

Now you can decode this string and will be the input relates to field "buffer"

This string "msj.....DY=" decoded will be the "buffer" on REST signCades like this file (this it the byte array to sign)

Descriptionpermits to obtain the cades detached signature (p7s) , from the hash associated to the file to signHttpMethodPOSTPath
/sign/signCades
Requestcredentials
Expand
titlerequest-signCades-credentials

{

"username":"device signer name",

"password":"PIN of device signer name",

"idOtp":associated to device signer or -1,

"otp":"otp code",

"sessionKey":"string with sessionKey"

}

cadesPreferences
Expand
titlerequest-signCades-cadesPrefernces

{"detached": true}

buffer

btye array relates to the hash files to sign

Responsebyte array related to sign of the hash and the certificate associate

REST RESPONSE:

"string",
  "level": "enum",
  "withTimestamp": boolean,
  "encryptInAnyCase": boolean,
  "encryptionPassword": "string",
  "lockFields": [
    "string"
  ],
  "needAppearanceDisabled": boolean,
  "page": 0,
  "signerImage": {
    "fieldName": "string",
    "fontName": "string",
    "fontSize": 0,
    "image": "string",
    "imageFilename": "string",
    "imageURL": "string",
    "imageVisible": boolean,
    "location": "string",
    "reason": "string",
    "scaled": true,
    "signerName": "string",
    "textPosition": "enum",
    "textVisible": boolean,

    "scaledText": boolean,
    "width": int,

     "height":int,
    "x": int,
    "y": int
  },
  "signerImageReference": "string",
  "withSignatureField": boolean
}


imagefile with image (of appereance)
 bufferPDF file to sign
Responsebyte array of signed files


SIGN: signPadesMultiFieldName

",

"idOtp":associated to device signer or -1,

otp":"otp code"filenameInTSD "string", "outputAsPDF: boolean,
  "outputAsTSD": boolean,
  "timestampPassword "string
  "timestampUrl": "string",
  "timestampUsername": "string"hashAlgorithmlevelenumwithTimestamp boolean,
  encryptInAnyCase: booleanencryptionPasswordlockFields [
    string
  ]needAppearanceDisabledpage 0 true": boolean,
    "width": int,     "height":int,
    "x": int,
    "y": int
  },
  "signerImageReference": "string",
  "withSignatureField signed files
Descriptionpermits to apply the pades signature ONLY on PDF with signatures fields already exist
HttpMethodPOST
Path
/sign/signPadessignPadesMultiFieldName
Request
credentials


Expand
titlerequest-signPades-credentials

{

"username":"device signer name",

"password":"PIN of device signer name

"

,

"sessionKey":"string with sessionKey"

}


padesPreferences


Expand
titlerequest-signPades-padesPreferences

{

 "

withSignatureField":

true
 

"

outputBase64Encoded": boolean,
  "timestampHashAlgo": "string",

   "

fieldsNameList":

list_of_signatures_fields (ex, ["Signature-Field-1",

"Signature-Field-2"],

   "signAllFields": boolean,

  "

timestampPassword": "string",
  "

timestampUrl": "

string",
  "

timestampUsername":

"

string"

,
  "

hashAlgorithm": "string",
  "

level":

"

enum"

,
  "

withTimestamp": boolean,
  "

encryptionPassword":

"string",
  "signerImage": {

    "fieldName": "string",
    "fontName": "string",
    "fontSize": 0,
    "image": "string",
    "imageFilename": "string",
    "imageURL": "string",
    "imageVisible": boolean,
    "location": "string",
    "reason": "string",
    "scaled":

boolean,
    "signerName": "string",
    "textPosition": "enum",
    "textVisible": boolean,

    "scaledText

": boolean,

  },
}


imagefile with image (of appereance)
 bufferPDF file to sign
ResponseThe body contain the byte array of files signed fully or partially
Response code 

200: the file is signed fully

400: the request isn't correct. The header params: "errorMsg" and "errorCode" contains the details about the errors

422: the file is signed partially and the header params "remainingFieldNames" contains the list of unsigned param. The param "errorCode" and "errorMsg" contain details about the error

500: an internal server error has occured.





SIGN: signXades

Descriptionpermits to apply the xades signature
HttpMethodPOST
Path
/sign/signXades
Request
credentials


Expand
titlerequest-signXades-credentials

{

"username":"device signer name",

"password":"PIN of device signer name",

"idOtp":associated to device signer or -1,

"otp":"otp code",

"sessionKey":"string with sessionKey"

}


xadesPreferences


Expand
titlerequest-signXades-xadesPreferences

{
  "filenameInTSD": "string",
  "outputAsPDF": boolean,
  "outputAsTSD": boolean,
  "outputBase64Encoded": boolean,
  "timestampHashAlgo": "string",
  "timestampPassword": "string",
  "timestampUrl": "string",
  "timestampUsername": "string",
  "hashAlgorithm": "string",
  "level": "enum",
  "withTimestamp": boolean,
  "detached": boolean,
  "detachedReferenceURI": "string",
  "signElement": "string",
  "signatureId": "string",
  "withoutSignatureExclusion": boolean,
  "xPathQuery": "string"
}


bufferXML file to sign
Responsebyte array of signed files


SIGN: signPKCS1

Descriptionpermits to apply the raw signature (PKCS1)
HttpMethodPOST
Path
/sign/signPKCS1
Request
credentials


Expand
titlerequest-signPkcs1-credentials

{

"username":"device signer name",

"password":"PIN of device signer name",

"idOtp":associated to device signer or -1,

"otp":"otp code",

"sessionKey":"string with sessionKey"

}


signPreferences


Expand
titlerequest-signPKCS1-signPreferences

{



    "hashAlgorithm": "enum"



}


bufferhash to sign
Responsebyte array associated to hash signed


Verify

VERIFY: signatures

Descriptionpermits to verify the signatures
HttpMethodPOST
Path
/verify/signatures
Request
signedContentfile to verify
preferences


Expand
titlerequest-verify-signatures

{
  "detachedContent": "string",
  "language": "COUNTRY_CODE_2_DIGIT" (es: IT),
  "pdfEncryptionPassword": "string",
  "recursive": true,
  "verifyOnDate": "YYYY-mm-dd" (for example: 2022-10-24)
}


ResponseReport with verify, this is a complex object: "SignedDocumentReportBean"


Verify timestamp


With SWS is possible to verify TSD and TSR using the preferences, below will be described the REST request.

VERIFY: tsr or tsd

Descriptionpermits to verify the timestamps in tsd or tsr format
HttpMethodPOST
Path
/verify/timestamps
Request
timestampedContentfile with timestamp
detachedContentfile original, where timestamp has ben applied (use this field only if you are verifying TSR)
preferences


Expand
titlerequest-verify-timestamps-preferences

{
    "responseWithoutContent": boolean,
    "language": "COUNTRY_CODE_2_DIGIT" (es: IT)
}


ResponseReturn a complex object "TimestampReportBeanSummary"


VERIFY: tsd

Descriptionpermits to verify the timestamps
HttpMethodPOST
Path
/verify/timestamps/tsd
Request
tsdtimestamp to verify
preferences


Expand
titlerequest-verify-timestamps-preferences

{
    "responseWithoutContent": boolean,
    "language": "COUNTRY_CODE_2_DIGIT" (es: IT)
}


ResponseReturn a list of complex objects: "TimestampReportBean"


VERIFY: tsr

Descriptionpermits to verify the timestamps
HttpMethodPOST
Path
/verify/timestamps/tsr
Request
tsrtimestamp to verify
contentfile original, where timestamp has ben applied
preferences


Expand
titlerequest-verify-timestamps-preferences
|

{
    "responseWithoutContent": boolean,
    "language": "COUNTRY_CODE_2_DIGIT" (es: IT)
}


ResponseReturn a complex object "TimestampReportBean"


...