When request is received by emCA service, the system decrypts the request JSON Object with same AES key that is shared with the client.
After successful decryption, request JSON object (Username + Password + Signature(noOfDaysToExpirySoon)) is retrieved.
emCA service will then validate the username, password and check if the IP Address used for request and registered with the user are same.
If request is registered with the same user, then the system checks if the certificates are available for the specified time period.
If certificates are available for the specified time period, the certificate details ( Certificate Serial no and specified time period) will be displayed.
If certificates are not available for the specified time period, the message “No Certificate is available for the specified time period” will be displayed.
Response Parameters
JSON Object Contains below parameters
Response JSON Format
Sample:
Success:
Response Body(if have certificate that to expired in specified time period)
{
"status":"success",
"result":"Certificates serials no”s to be expired in the specified time period ,
“subscriberId”:”XXX”
"requestId": null,
}
Response Body(if don’t have certificates that to expired in specified time period)
{
"status":"success",
"result":"No certificate will be Expire in XX Days,
“subscriberId”:”XXX”
"requestId": null,
}
Failure:
{
"status": "failure",
"result": "<Error message>,
"subscriberId": null,
"requestId": null
}
Parameter
Presence
Data Type
Description
subscriberId
O
String
Pass the subscriber Id to fetch “soon to be expired‟ certificate details of that specific subscriber (or) leave it blank to get “soon to be expired‟ details of all Subscribers.
signature
M
String
Pass Signed data you want to validate or verify.
userName
M
String
You need to pass username that is registered with emCA for API process.
password
M
String
You need to pass the password that is registered with emCA for API process.
Key
Presence
Value
Description
Application / JSON
M
Content-Type
Type of request should be in JSON Format.
Authentication Ke
M
emKey
emKey is an encoded key (Refer section 4 for generating Authentication Key using command prompt).
Parameter
Data Type
Description
response
String
Returns JSON Object
Parameter
Data Type
Description
status
String
Returns Status of the request as “Success‟ when the Certificate details to be expired in the specified time period is fetched.
Returns status of the request as “Failure‟ when authentication fails or unregistered user tries to call the API.
result
String
In case of Success: the Certificate details to be expired in the specified time period will be displayed.
In case of failure: Error message will be displayed.
