When request is received by emCA service, the request JSON Object will be decrypted with same AES key that is shared to the client.
After successful decryption, request JSON object (Username + Password + Signature (Profile name)) is retrieved.
First emCA service will validate username and password and check if the IP Address used and registered with the user are same.If request is registered with same user, then the system checks if any user profiles are available with the requested profile name.
If a user profile with requested profile name is found, the Certificate related information of that User profile will be displayed.
Response Parameters
JSON Object Contains below parameters
Response JSON Format
Sample:
Success:
Response Body
{
"status":"success",
"result":"Certificate related information of requested profile name”, “subscriberId”:”XXX”
"requestId": null
}
Failure:
{
"status": "failure", "result": "<Error message>, "subscriberId": null, "requestId": null
}
Error Messages
Parameter
Presence
Data Type
Description
userName
M
String
Pass Username that is registered with emCA for API process.
password
M
String
Pass the password that is registered with emCA for API process.
signature
M
String
Pass the Signed data you want to validate or verify.
Parameter
Presence
Data Type
Description
requestData
M
String
All the request input parameters mentioned above should be converted to JSON object and encrypted with AES 256 key shared with you by the emCA team.
Pass Encrypted JSON Object.
userName
M
String
You need to pass username 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 Key
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 Certificates related information to that Certificate Profile is displayed.
Returns Status of the request as “Failure‟, when authentication fails or unregistered user tries to call the API.
result
String
Returns
In case of “Success‟: The Certificate related information of that Certificate Profile will be displayed.
In case of “Failure‟: Error message will be displayed.
subscriberId
String
Returns Subscriber Id
Error Message
Description
Invalid Certificate Profile name
If the given certificate profile name is invalid
Signature verification failed
If signature parameter (CSR) is not signed by the pfx shared by eMudhra