API Programming Guide › CA User Activity Reporting Module API Examples › API Registration › Register a Product

Register a Product

You can use the registerProduct call to register a product for single sign-on purposes. Registering a product creates a certificate which is stored in the management database. You can use this call where it is not possible or preferable to access the product registration interface.

For example, if you are integrating a third-party product, you might not want to distribute the EiamAdmin password widely to allow certificate creation. In that case, you can create a certificate and password and distribute them to those product users to set up integrations.

registerProduct Examples

https://ELMSERVER:5250/spin/calmapi/calmapi/registerProduct.csp?action=register&certname=YourProductName&certpassword=CertPassword&certname=xxxxx&password=xxxxxx

In this case "&certname=YourProductName" defines the product you want to register. Replace "YourProductName" with the product name you want to register.

"&certname=xxxxx" specifies valid certificate name and password.

Success Response:

<?xml version="1.0" encoding="UTF-8" ?> 
<Result>
<Value>true</Value>
	<Description>The product has been registered successfully. The default access rights on the ELM application have been provided.</Description>
</Result>

Failure Response:

<?xml version="1.0" encoding="UTF-8" ?> 
<Result>
<Value>false</Value>
	<Description> EE_POZERROR Repository Error</Description>
</Result>

Note: An error often occurs when the certificate with the name given in the URL has already been created. Another common error description is “EE_AUTHFAILED Authentication failed” which indicates the password was incorrect.