Note: Some of the Kluis API requires certain setup and configurations by login to Kluis Console using Web Application before those may be used successfully.
Base Url: would be depending on your domain ex: https://api.signer.digital
HTTP Headers:
Header
Description
CscId
Required for all API Action calls except 'GetCscDetails'. CscId may also be passed as query parameter.
Password
Required for all API action calls. Password may also be passed as query parameter.
TxnID
(Optional) Unique Transaction ID. May be used to match Online Kluis log and Client Application Log.
ThreadId
(Optional) Used for SignHash or SignPDF actions where multiple signing sessions are required for multithreaded calls to Signing API form client.
AppVer
(Optional) Client Application Version - used for logging only. May be helpful in troubleshooting.
API Consumer application may have common method to add all above headers. Kluis API ignores unrequired headers.
List of available Kluis APIs are listed in below table:
relative URL (Action)
Methods
Description
/Health
GET
Health Check API. Check health of API server. Respons is "Active HSM: KluisN".
/signer/CertificateV1/GetProfileCert
GET
Get the Certificate of the Signing Profile. This API call may be used by application to get the signing Certificate which may be used to build signature appearance, etc.
/signer/CertificateV1/SignHash
POST
Sign Hash using specified Signing Profile. Returns RSA PKCS1 Sign.
/signer/CertificateV1/SignPDF
POST
Sign PDFHash using specified Profile. Returns CMS PKCS7 Sign.
/signer/KeyAuthV1/GenKeyAuthOTP
GET
Generate and send Key use Authorization OTP by sms and email for specified CSC, KeyLabel and ClientAppProfile.
/signer/KeyAuthV1/SetKeyAuthOTP
POST
Submit Key Authorization OTP for specified CSC, KeyLabel and ClientAppProfile.
/signer/CSCUtilsV1/GetCscDetails
GET
Get CSC details like CscId and BaseUrl for specified UserId and Password.
/signer/CSCUtilsV1/GetApiBalance
GET
Get ApiBalance for the pre paid Kluis CSC Account or Group.
/signer/CSCUtilsV1/GetCertProfiles
GET
Get list of CertProfiles for CscId.
/signer/ApiTxnV1/DailyTxn
GET
Get API Transactions for the specified date and optionally for specified (API) Action.
/signer/ApiTxnV1/DailySummary
GET
Daywise API transaction summary for date range. (Under development).
/signer/ApiTxnV1/MonthlySummary
GET
Monthly API transaction summary for date range. (Under development).
Following sections provide details of API request, parameters, response. Also .NET and Java API Integration demo project source code is available for download.
