API Method - getProfileinfoByProfilename

Purpose

Use the “getProfileinfoByProfilename ‟ method for fetching Certificates created under a specific Profile by using the Profile name.

Type of Method

POST

Request URL

http://www.example.com/emCAServices/rest/getProfileinfoByProfilename

Request Input Parameters

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.

Sample JSON Object

requestData
{
"signature" :
"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwGggCSABAxlTXVk aHJhIGRlbW8AAAAAAACggDCCA7cwggKfoAMCAQICEFcqUaCTmZDPwWG14f20A1cwDQYJKoZIhvcNAQELB
QAwdDElMCMGA1UEAwwcQ2VydGlmaWNhdGVNYW5hZ2VyIFJvb3QgMjAxNjEYMBYGA1UECgwPZU11ZGhyYS BMaW1pdGVkMRAwDgYDVQQLDAdlbXVkaHJhMRIwEAYDVQQIDAlCYW5nYWxvcmUxCzAJBgNVBAYTAklOMB4 XDTIxMDkwMzA1MzMzM1oXDTMxMDkwMTA1MzMzM1owLDEXMBUGA1UEDwwOQXV0aGVudGljYXRpb24xETAP
BgNVBAMMCEphZ2FkaXNoMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAkLMjR+X1HXNdwI6UY
jcgVSyYrsKfpCqVuHslMjmIIlvL9VsnadfA7BcOCp+MUNDSRMeB0VnjQKbM3Li68JOQgtP86pfoNcuC8l 7aPMFSb9Y7G3FFp6C+mFlCj/l/DtW41Eg+Vft72gig71roam7jIS0Seiwnx7VUbGM4S7tlfWVyl3Kgli6 zLaNvSresMbwrHzI+Yba/ugcteso8RSxiewJZXKl/0XFR4692EUCM/LgvgH5f9k65gIAm14ZYOWMKaZG/
/2k9mpGmyiDDw2APGg+Q8sZsb8fWkGMrNnLb/71W+0b5GvEXROzRbNM6Gbnpxq2RjTL7qvklnKn4e0Y+O QIDAQABo4GMMIGJMAwGA1UdEwEB/wQCMAAwIgYDVR0jAQH/BBgwFoAUgrVRaCBCfAEiYlkr6rtaEbNDgs EwIAYDVR0OAQH/BBYEFL8rAOGSawss8e1N3/DmmEGyDqfhMA4GA1UdDwEB/wQEAwIEsDAjBgNVHSUEHDA
aBggrBgEFBQcDAQYIKwYBBQUHAwIGBFUdJQAwDQYJKoZIhvcNAQELBQADggEBAGWDntlaeu+5baa1RRH1 hpYZK1VHei9jpZwaHKWLXOwLGBwDuTWTUSgs/zmE2QEAq1Drp1+zg0sfsnK+MYR0qSX29kPrTVzUrrEsK 4XQJojOxMgg3XUsUXjAQNaghp1GdED2Q7wIb3N+1mtXwHWuthZVWko8jeE/Rp0hKJU6wutmTX1jVQudrT
/jIMTQRX41iUnRSOc8Ipxc8LaeufNd0km2q069QZAUNzMffEtAOtgJKCyZaN9uILhVs0nKtBQAk8UU2jt vNjRVgUiiThy4pNOZJWozoVZ8tZc2rQCAyjx4MXiOPheTKrjZGMzxZ3EF7Zpfn+HqY/lDkns2+c8HHFMA ADGCAh8wggIbAgEBMIGIMHQxJTAjBgNVBAMMHENlcnRpZmljYXRlTWFuYWdlciBSb290IDIwMTYxGDAWB gNVBAoMD2VNdWRocmEgTGltaXRlZDEQMA4GA1UECwwHZW11ZGhyYTESMBAGA1UECAwJQmFuZ2Fsb3JlMQ
swCQYDVQQGEwJJTgIQVypRoJOZkM/BYbXh/bQDVzANBglghkgBZQMEAgEFAKBpMBgGCSqGSIb3DQEJAzE LBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTIxMDkxNDA4MzI0NVowLwYJKoZIhvcNAQkEMSIEIMBU 1HQzaVuXwswIYjJZ76To8KDNYS66oj3wOQx8xrHVMA0GCSqGSIb3DQEBAQUABIIBAC9MFe4rKux1xnt2w
eqvw88U6o7oLxDvVKJnUJOfG7+C8XMy6R8DW/CvWqClM9l4xtyUc50axfYiXkdlo1rVkzd6Ctjg4wPMQD AUwOT3VFAww8FAuIuaSPczPYlGNnYCFFVq/WtAWpVrbtr1k77wk4u8LmTlWUIaUjfF7c6gEViklfQul6l W5DkwmpkG46ECw6fVNGFBevA9mFM0yJoBKgL5PnUtPbr4jMvU5dnKLrbtOwSQs/sZ6VJNrzudGyvQxC3s toK4fRCLz7uqfN6jMxh8lTIszTJV8vKrKo4rzOmFsgq3tWgQYRKIMycMgul8dXX8XWmZT6NVanuy2zlDC dQAAAAAAAA=",
"userName" : "username", "password" : "password "
}

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.

Header Details

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).

Sample Request Data

Header:


Request Body:
{
 
Content-Type	: application/json
emKey	: 47b54594063957de22fce0aeddd51a6adf4a80aa
 
"requestData" : "DcojYlq57vrFInQ3TypNPKWGZiQ4GXBcIpEaW1hkQxe0qHi5AvBMKnz97dpVOEezet5CoX1UPugOXu2 5w4fqyPKOhnBLkhrg0SDPEJLvGHgvZNBN5uTQ6RWXA4FHnjWIE67SytYHgeQ56lEFxrh1YccIRIwxVUT wxSLDKLQO+gMV1XfvOE1dlQATFBeFeYtFihfTrWIyDdOLbV7OhxGnWdsRxPYou92H3vnRTnL5ooyHWsa zrtlQcoKlLkN+xE5YvE0HW6De2ZSeYzlq1YeKjROz5a4ApoVrXFwTIVbymvdu8n/mjWy2MgjCErZ8Qcw DXYJJWrpiG+RPt9K/rXIs/G8S82QNbRAVJ5z8M+1RwkKEXLEqDJ5DPxRUn4WBtBSGzb9Iu9XTqeCAZgF
XHxrQ8U0CSzOfdVhEyRYbIFGy8zYZWwBWhggXlAmeGCgnk8d5JG/t9QSN0DncPaR4JnBRVNIB2cRvxic v6ayZS9ixPKxoOSdMRfJHQw4Wx5HxFpxkOCrCvX3wy5jt8UBicJU0EkJv24PI4PAeyBYHfQzDQoybe8a Spp7T7Zm7lfcvXY4kWo1eUiHM4aPtKr4edKNyIWLc44qCePBO+i1C3pMrwe860GL4K6JcDgGLCKppULX vg3ENkPaSGcEKdABahe/n35/8SisRhAk7BgLgJ2zMgbnPi982iBSd7IRCcalJbILY5orZvVbHu2tnBSE V/5T/8II+gs0zXFdJ2AP0p5MZzzIPqpqMU6AHXsfRxDE2MD0EsjqsjgsBFHAK3YGHU5UbUJBmqtWpuh6 1izIhoSaPTOwyylq2JR2bKD1RoWwCr3FNGvJGVip5C1g1K4cHF0dBJZoSN3Z5K1g74VmaFfaKCk7KaXn G+LVlAp+5xIwfm3NNQBitNPSJQznndcRHYBNdOxbBaaIkI38Pk2EKtI6LxdwRBx48+Y3A18eX/FJEnfm OroMIY35oHH4lvI2Radx19wG7Onf/3ild1ykauZOj6Hr7gCmC1ExBrGHvBVgaPp6JsKgvLNlDai2A5ik KHxXc1Gde8LGckEejbDxf6ev5bUci040WWHdxEHP15a3Gb3TzY2ZuVOf6IvIPlp814QdYeHgPomK9Bir YQpy79PtNwCAuXR8afCQsUMl8Dca6ZUOw31QStSdKIfts1ZQehGaoi3worIQ0FBuv2F7wBSRGNOm6Wjr WKqjk+WHAHoHczhX8gyX+iXL1xC2gVH7DvTh5dUjp6uf8UBX+wsCijX5hHVr5f1pciYM0AynW0dYj5zJ R8plvarHab86vmAbtHH66F5qBS9p4e7ZNq9l699T35BmN21oWAp1zr04Ua2BUykXbAwWtv6SyoExJCMg GwkGW+t4na7d1OBOM0WHrF16PUm6yfxrzjuHsQwsMsIC/fiSAYXXg0Nli/ZUeeT7OPS86vi9YrNUD0pC mXOfRx8+QZmkQ3lfVc5twAYHO0VVf7xAs7iaLa3o8yVaeT7PzGdtb1lpK4gEhm7gwQlya2b7wvsVg6mW
/hzifM0rxDRM1exMxk1Yh/b/IfzkIH8qAt0D79uKjLiq8Fgrgsszq3pENMQJqqqw1wEr9VQLYG144BzB Wn736KCEc308dUMzoqEDNSYWFvj5pIs0KMQqGnMtAf3EzpdTgsSEy4io2b0VGzk5KSHgoBpdgbAkKlr7 axZqTbaUalcviIKo/xS2LqTEAkbTdif8s+irYeU33re5flumV2tnG25+Jtp4n07GSKqR1gOnaGYiGZWo 0Rvjeb1JOYvQR1G44GB805gOeOMGgG1wfJQ1ZD8xaT7uKLkq6UG4PjRZpC18U1ush3FBgB3T49D6FJCY
BQEBTgYsZSnm17SjEnuemnFSGPx5wGL1HjBUAjXFlK0Jaxe2h/MgTP87lxyrCTeQLKVwdQdqu4vZ6q6v kpWbA8WdztB3pO/eCXRc3IOjNKFHDADQKC5hmet2FwQnMey4Wt//vsBkgsUqNenQ37Lb2TIPNum+j1Xl u7EvWYvWfINrpP9tMOhzplwIqyFD1FE9/Q5mvHQfydo8lBIzInDDdCRFxtYHAq2eQ/KifHpVoJr5hGKJ 2oCUl/0fv7dOe6TOYUdDnYK43wl/GPDNtViT/GUDFR765IpR4R7us1noRQaD6xI3DkI04F6vRwezW8j/ zMtcuRetYHCbYZ3Lk3z6rVVYwV9YwSLQ/d9H73jElklvLMSFQESm92V52oWW3U8zigKYKWuTP3cmkt4k fNbZ9NtJkzweRszFxTA12M7iKOYQyZPflcW6cNUrqm7138NTxa66zdSnEIRCE8GW/1BRB9e3641Q870K Mvp0Y7O09FhWqdZ8I1C9AJSuNvqHflVMpmfMMLTrxDSCXx/6/D4H3BXKTeK8NQ96KRRqewcYrNXXOxw6 MC4z+hMryx3IG5fB3NiEo90wcvgSdeLSd1rTe0KJB71Bc7pwfpWBgYmOJNxVirP5ShdylFK34kuw3NB8 L4PX29ngkjAAu1smOt/044Gcbs6tL5xKVlxfm2SVwq3dvBIHKXfcIaGPIpJi1t6iInL58RUGR6s+na/r m5dMOqOpOwgslS/X0TosfhOo8A6kuDsqjh63ha98rEDW2jVAkkkhsCnEaS6tU64BcBx304rouXP/4Dr/ buHTmtjIgDNf4uMzZiww8FcR6S6ahKE6keQ+ldlVE2nJlB9Z5AaIE7vw/L9SPAye23/HsCQB7Yd7FOLb Pi769+8MqmTEZgkRFNQYP9Fz29sAwlWQs7JrV8r8gHMXlYWl0L9/GQek5FObb+HMMdxXVTHjBLGVPCXO
8i+isDsqgFmrenPR9Bke9Xyav2DnIuDcAFe0Lm2GNC1WgfZKYccDCO3eWFGImQ4mY01pE0dWjz7tEych OutEFQcWAnFD4jEoquF0oK2AV+cIbEBZuG1yrmCCdqd4SO67fcgJbFevnm7F0uzwyQsn9uAmhSEWAsCW SLsk/0Q=="
"userName":"username"
}

Process

• 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.

1. If a user profile with requested profile name is found, the Certificate related information of that User profile will be displayed.

Response Parameters

Parameter	Data Type	Description
response	String	Returns JSON Object

JSON Object Contains below parameters

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

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

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