Versions Compared

Version Old Version 18 New Version 19
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 guid will be described how manage the error generated by the REST interface.


Enquiry

ENQUIRY: certificate


Descriptionreturn the certifcate associated to "device_signer"
HttpMethodPOST
Path
/rest/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
/rest/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
/rest/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
/rest/enquiry/otps
Request


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


ResponseDescriptionreturn the numeber of timestamp available (valid only for Namirial TSA account)


Expand
titleresponse-enquiry-otps

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

ENQUIRY: timestamps-available


]




ENQUIRY: timestamps-available


Descriptionreturn the numeber of timestamp available (valid only for Namirial TSA account)
HttpMethodPOST
Path
/rest/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
/rest/enquiry/timestamps-availableerrors
Request


Expand
titlerequest-enquiry-timestamps-availableerrors

{
  "timestampUrl"error_code": integer,
  "lang": "timestamp-namirial-enquiry-url",
  "timestampUsernameCOUNTRY-CODE-2DIGIT"
}


Response


Expand
titleresponse-enquiry-errors

[
    {
        "errorCode": integer,
        "errorLanguage": "CONUNTRY-CODE-2DIGIT",
        "errorLanguage2": "tsaCOUNTRY-CODE-username3DIGIT",
          "timestampPassworderrorText": "tsa-passwordDescription error in language"
    }

ResponseNumber of timestamps available
ENQUIRY: errors

]



Admin

ADMIN: remove-certificate-from-cache


Descriptionreturn the error description associated to error coderemove the certificate from cache of SWS
HttpMethodPOSTPUT
Path
/rest/enquiry/errorsadmin/remove-certificate-from-cache
Request


Expand
titlerequest-enquiry-errors

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

Response
[
    {
        "errorCode": integer,
        "errorLanguage": "CONUNTRY-CODE-2DIGIT",
        "errorLanguage2
Expand
titleresponse-enquiry-errors
remove-certificate-from-cache

{
  "error_code": integer,
  "lang": "COUNTRY-CODE-3DIGIT",
        "errorText": "Description error in language2DIGIT"
    }]


Response


Admin

Timestamps

ADMIN: remove-certificate-from-cache

Descriptionremove the certificate from cache of SWS

TIMESTAMPS: apply

Descriptionpermits to apply timestamp on specified file
HttpMethodPUTPOST
Path
/rest/admin/remove-certificate-from-cachetimestamps/apply
Request
timeStampPreferences

TIMESTAMPS: apply

Descriptionpermits to apply timestamp on specified file


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

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

Response

Timestamps

timestamps-apply

{
  "filenameInTSD": "string",
  "outputAsPDF": true,
  "outputAsTSD": true,
  "outputBase64Encoded": true,
  "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
/rest/timestampsuser/applychange-password

USER: change-password

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


Expand
titlerequest-user-change-timestampspassword-applyremote

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

contentfile to apply timestamp
Response

User

  "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-remoteautomatic

{
  "credentials": {
        "idOtpsecurityCode": idOtp or -1,
    "otp": "otpCode"securityCode associate to automatic device signer",
    "password": "old-password-of-device-signer-remoteautomatic",
    "username": "device-signer-automatic"device-signer-remote"
  },
  "newPassword": "new-password-of-device-signer-remote"
}

Request (for automatic device signer)


  },
  "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
/rest/sign/openSession
Request


Expand
titlerequest-user-change-password-automaticsign-openSession

{
  "credentials": {
    "securityCode    "idOtp": -1,
    "otp": "securityCode associate to automatic device signer "775351",
    "password": "old-password-of-device-signer-automatic12345678",
    "username": "device-signer-automaticRHIP22021116852552"
  },
  "newPassword": "new-password-of-device-signer-automatic"
}


ResponsePassword update succesfully

Sign

String with the session



SIGN:

openSession

getRemainingTimeForSession


Descriptionpermits to open the sessione for apply multiple sign with remote deviceto obtain the time until the session is valid
HttpMethodPOST
Path
/rest/sign/openSessiongetRemainingTimeForSession
Request


Expand
titlerequest-sign-openSessiongetRemainingTimeForSession

{
  "credentials": {
    "idOtpsessionKey": -1,
    "otp": "775351",
    "password": "12345678"zZto1G0DpL/vBFkTnK7caquzY5pasOlzS+bQG7wUkOONnbV7Vhd+JSPTjP7ZqTYR12QjS0W89T7UmnQB2KzAQ3C4NalDgFE67ntqoGm7uOU7+oOPLvKQv/p5aeZ2bcjKe6x5KQPUEH//rKaExFcLcLj8cnwXfFBixJ4MN+3o8S5535HcRxWv+YoTHHgAY16Fh0yJGfLL3x/4W+HJeiIYL2cHpKNTGkKcGTM8Eon0R+djNFvKzZSF1VIETPADqDdvgLYkRWODd3yoUvExGk5BcQKVm0Z7Nd7NMKl4NRbHumdqmqy81jchQv2qlXIxSpjZ0GTnL4vDZMF2MP2DGHPoWw==",
    "username": "RHIP22021116852552"
  }
}


ResponseString with the session

SIGN: closeSession

Descriptionpermits to destroy the session
HttpMethodPOST
Path
/rest/sign/openSession
Request
Expand
titlerequest-sign-closeSession
{
 TO FILL
  }
}
ResponseSeconds until the session is valid