API Method - getExpirySoonCertificate

Purpose

Use the “getExpirySoonCertificate” method to fetch the Certificates that are to expire soon based on the time duration and Subscriber ID.

Type of Method

POST

Request URL

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

Request Input Parameters

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.

Sample JSON Object

requestData		
{
  "noOfDaysToExpirySoon": "XXX",
  "subscriberId": "XXXX"
"signature" : "MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwGggCSABIGLQ049dGh1bGFzaSxTRVJJQUxOVU1CRVI9QVZBUEc0MjAxQSxFPXRodWxhc2kuZ0BlbXVkaHJhLmNvbSxPPWVtdWRocmEsUz1LQSxDPUlOLFBvc3RhbENvZGU9NTYwMTAzLEtleUFsb2dpcnRobUFuZFNpemU9UlNBLTEwMjQsUGFzc3dvcmQ9MTIzNAAAAAAAAKCAMIIDpjCCAo6gAwIBAgIDTEtBMA0GCSqGSIb3DQEBCwUAMHQxJTAjBgNVBAMMHENlcnRpZmljYXRlTWFuYWdlciBSb290IDIwMTYxGDAWBgNVBAoMD2VNdWRocmEgTGltaXRlZDEQMA4GA1UECwwHZW11ZGhyYTESMBAGA1UECAwJQmFuZ2Fsb3JlMQswCQYDVQQGEwJJTjAeFw0xODA1MDMwNTUyNDNaFw0yMDA1MDIwNTUyNDNaMCgxFzAVBgNVBA8MDkF1dGhlbnRpY2F0aW9uMQ0wCwYDVQQDDARyYWNhMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAm4k/r47G8+eRm/zftRSwxg8koTXLEHGJF5MKJZjUsPweASFbxxcj1RwixCHaAP75n3u0JCOFBuOVDMlPMu47j9w+x6jig3IMdVhPo6/rU7Z75GtwFQDvhLZhoz2VMrSThfjvhaYEiOYy4uhC7sXOVedCw3rFylFtbljgwgnPC6Rp75TesIKj1l+9dZY08OxyICNUNluztcMOXDqk68rtzbZfPvtfH4msDpyUoJL7XmBwbXF7UMiISlCiSvqpjYyBsu+tPxuOpgxlGbyJGmWfi9D7Nzg4a8SBW6NrRWhtGASUj+/SaJpH0LI5wTrmMri8vJ2r2LHyi0zdpk+9S8u3vwIDAQABo4GMMIGJMAwGA1UdEwEB/wQCMAAwIgYDVR0jAQH/BBgwFoAUgrVRaCBCfAEiYlkr6rtaEbNDgsEwIAYDVR0OAQH/BBYEFJ4vM/W+gFWsqBapUx9p7OSBQfDbMA4GA1UdDwEB/wQEAwIEsDAjBgNVHSUEHDAaBggrBgEFBQcDAQYIKwYBBQUHAwIGBFUdJQAwDQYJKoZIhvcNAQELBQADggEBAENZq6xWQGZE+cwOD0CigiZYQqDRBpeMW1hhtlo7isiKWAlllAZ60aHZ2pMAO30VVwvifEjDv2QvCe+IA5d6x/SIBt0f/FypZj6T4vY6h6Hcaks7zI3gozMCCuHBeBS/wA7LPwyxkxxFwUzDeJkLYfmkFQH6HN2OT3BqY3cA2Qon/NHRdCc5vvY9pbSR0j4y/2wXqzROIyYjXt3U2z/IL1pkDlmpDmYzbafdIlCJ6xyFOKNRoLp6QiGTZNs5UaVPnxMOvsh2sA1EirFFsRiDBJ6ycrAjff9ls4oIc5gpgp7TArXbogFP1lw5j8nj50se46Bv0aQ0D4WdThCljcC6xQMAADGCAhEwggINAgEBMHswdDElMCMGA1UEAwwcQ2VydGlmaWNhdGVNYW5hZ2VyIFJvb3QgMjAxNjEYMBYGA1UECgwPZU11ZGhyYSBMaW1pdGVkMRAwDgYDVQQLDAdlbXVkaHJhMRIwEAYDVQQIDAlCYW5nYWxvcmUxCzAJBgNVBAYTAklOAgNMS0EwDQYJYIZIAWUDBAIBBQCgaTAYBgkqhkiG9w0BCQMxCwYJKoZIhvcNAQcBMBwGCSqGSIb3DQEJBTEPFw0xODA4MDgxMDU3NDFaMC8GCSqGSIb3DQEJBDEiBCCRCU2QQn8vWt9lA+SkB/8weIKlUaHaSgmDqE4GCgQZ0TANBgkqhkiG9w0BAQEFAASCAQAIjlSTHf+7EXSUuFV7S57vDdYyu5AhE5iJ2dJl03zo/Bc62yMRgWGPpLSTFBjo8102VQIACxfudcCNoV1pfPkTxTyhe/rMv/VnWaMcLLrJZ0JRu7WZgrfHkBZ7p1eIv6LRt/nja93Fuc2M8Jl8B00DeQDNkyjnIN3gVS+0Hr8/ZIfClYa3huxfm8h1PeQHupaZ53UZKONLe7rRVVJGIA2IZwRkXcxk/2Z47qw1hUFvtXokQBbqOj1rDhL3Dh6pOsU9XbXTKGXzmcs0I6RXSB3DHbwQtsPK7neEyJBbxS0IpiKxY7IZtF2+m+WXmjWQyg7ZIYK0/X96XkYA7W7rcEPjAAAAAAAA",
 "userName" : "username"
 "password" : "password "
“isSignedData”  : “true/false”
}     

Header Details

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

Sample Request Data

Header: 
              Content-Type : application/json
Request Body:	
                        {
{  "requestData" : "DcojYlq57vrFInQ3TypNPKWGZiQ4GXBcIpEaW1hkQxe0qHi5AvBMKnz97dpVOEezet5CoX1UPugOXu25w4fqyPKOhnBLkhrg0SDPEJLvGHjFt37gGiL34CUIym5UAQTZKMlnVYTgL/TTnBCQ18oHl0zRoekr3oR9SbHqUGe5+HuSs7YVKNMkKvKNkoZ78luvs8ahK4vbkqzcLhM3x87q7mSUnZdvBn/8c3vm9EZizNbEXlSCIsGvyu3D5gErXckUTOgxCvlVEMEyqyc8kVPpDy5LvLdefoyP8cNjekJaGBF2DYZo/onkiesljtbwicj8ypGqBLi6351P8yTtYE3zSNRj1SpF+Fb86pkuiv4HJs6nj8j++GdYBHQVB3hnvv/b1JH/8ycos/8Xfi5+dMX95pclGs76sD/BEKZZRO0KreVWPSGMpX4ZaH6S/T45S/sbsuJIYboILofms+3y5Nem5dDF5rwYDv1c/X0yhFDy380VizBc3+ceJR/x6JgwoLpNizqwIYYe2puB1epG+NPD/jZf/9T2Qo81e8QvWNEGERvYkz8e4hNygKA2nGRGta66KbqJYkoaLEMI9eX7af3ZZu8Z072eN8pxo76CBMze02tqgKM7T7SrNjsc1eRyhvaorinkpmM9bPiaKSH0EUx4zH63NPggsxUtoLGsEoq7QIQZa8kJvjsxtq9EkgmATUOf0cn22Tbt5i9WBExAuR09feigIeOfqpv0VTlka9F2n2MUiIWOCiH37WZDlhQn9RRfF3rr3KF12UTHwAMc8Bov0HpM6nxmspD9tOzV4g8BhmTfQBur9VBBHA9bI7Y9EODjw2hnyU1X3tg3phadLwphkh83+b+sS7T+61sJnpA5HqjEyJ027mRymuPMPXksKGsyf+vQmRlyBC4pHKEtKBxGT/OPZPrOcQ1DTfxLdLAB2fj4FN8YNi8X/ofyJZOkIWxDYTdGqFPBgHNcaO8dy3vgpcU2PLg9dsnqi3m6tUNXkfYMF3Gjlx7S3shRR4QLEaia4GiGmxZ5RBhrYq8iSr4mzTaYnr6bI8+6WXwCF7+ZK1Cv35NV2L/PdzmgI8beKwI9hynLUOEcqs79lDeuph6F3DNSuI2+KmSfef26+U7oyIeZhkIIHapx6VIOeN8hHrQUB7hEDUglbZEsWc2Eoh1PZiIl7qPnQVLRJtYSdDIx8GvgTs0MGAARxHHBgPnj1i5IjFm5WjmyyhHEPFq45sT9FAtXCD/ktd+7EHVQobRUMP9Qiip+jq8gS/dpSTWfgNPQNHJTDLlMxwThAWDoRtl/lrQDV2o0GAxvdo/MHk8EA4owhG7YO4mNHLf7Fsr3BqpF2ds1C80/PkJP1P1qx8D/lvNWbHz6p8rbyCEHGl+fGfAeSNd4cEe9gO4IA8QphV8G18pKSCpdW9DMeFj0dUY4QOG+A1D/tm72u2soxoqMyTA7XLbSfFMDFbE3R+MnopXVZ7k7555QqA112wDcEQF6lUq7sjRs7Mvdbm8+lrw4wt8KaTrOoPtGKvSNl2M8Hd2yF6EwCOew0Blya4b4gYlIc5OcjWobafy0A8A+AINakVugYEkjvv1Zw7jKZx3edUTWPyIPmWNJz7XNlYU0fpZxKQz9yBIJPMoCzWQQ1rPR/40uNN8pYfQeY88LvS50LGdvjF/N2kPknrQLDtMaljsPPXVg3a2HLQE0NgXXKopbFzb74aoled43XI9/a3exm1Hzc/BR7HBq/yS8EEqBRDLgCrvYzr5KkW5NNLouiwpqI0St7/1t9EGbty77FQyqsSgFuOYxx1qey6m6yavq3YFDfdlo1fXZv4FbWcs8fS+g4Vz+9jPtmvBqZuMfUeWycKyk0TqwjLmgi0pODtebS2ppVVkp6mUKrhTMFji+A0IT5GrNqA+66ROlMk9+sV0I2AuEYELBOUIj7NwSm4Ms82bIDLmdtT55cP1HW4PkdOIcEnIAONdiev5nUXPeCzI9X+HcsmNpz+DAiLHsFj5jiawTpXhMyoGiMqzWqkjbYxTK5UMKlAjUuqPbXTlVpv8DPGN5xFxHBseQdUntmbn94vj0uU5FsVVDDTfpUg+Vmi3ZjRKopqg+eRG3dplLSB88QWClhD8fipcFKw13IPGdDhd72rOSpkXgGQpOMtfRPiWgRibDBgKiGwhYwI7Ofld3zM9NuZQmXgBQVj3Ta0Rz0Avlt/H5lFj2IpEZtv5+Tvdzb783kn21MKpWCzo83IRnWbJyqahSEqXX7qQmX47hUhhH4iY9y8YwqeM90NSupvifex3I/qZdlHBhRqHyeipwE3jYAsZIQdm0bwrXwZN47j+LSlWossIMRcVF++U9EcDYYPdhdAolkF+9skPY+zyuWPiE/SchzXnshtsTiYQssqWzDggqu6YjimnDSfwc/Vh/sZ1Tkn3HMgj7/R4IZPEO9ploknc4NpLNKL4aI74Yj6yS8nrt7Wpmk8Ev2OWMV62RKWlxYtuA/QRqsGFMHebkhuC/TV8I+A1jZZRK6xW0cEyEG0LyaMtdMdls1b4JQTUkYs1s+S9r3q40ky9+OGZdT2nSYJ19t68GanNtfR6/6li0cJDNEMlInQgUY9703Qykn1cEpcoH0vQ92pLCicQ0aRDAcdAotk1U42+dNR0yy7Hae1cmASMoqyLTEBqDVkU06Shl0nnPn/l6ZNSffEY5c8WJG6kLoXCC+bw1HSZVKBahTwJ8S0tmPK3G0+3LKep3s31YyrmlIgFAAdm+qGBf0N3sG0ARb7lLs7uRqUS3eb/q1+OU73ftuelEku8r2fsAlfDfShWH8ocdbvaLt3cQ7st/V53dVjzcfcHPZx40sw3prVEIBBwV01eV2BPn+RQgyQnB6sLdqUBzeunZEfCNx5jw5KGMbjAc1U+ZkB/KYj/EfUo2H4/KWvBJ9QzX7jcFrzZaeZY+FgtGp1wF+5eBZtB9XmHSPihwra28/JDGWqt1ow=="
}	
		}

Process

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

1. If certificates are available for the specified time period, the certificate details ( Certificate Serial no and specified time period) will be displayed.

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

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 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.
subscriberId	String	Returns Subscriber Id

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
     }