A Cloud Component Provider must expose a series of endpoints that the Eloqua Cloud Components framework calls out to.  One of these endpoints is called "renderInstance".

 

The renderInstance endpoint generates and returns the HTML content for the component from the external or "cloud" system.

 

Here is an example of what a renderInstance endpoint in the Provider could look like:

 

This endpoint will be called with a GET method.

 

https://mycompany.com/ccpservice/components/render/{Id}?assetId={AssetId}&contactId={ContactId}&visitorId={VisitorId}

 

Now, Let's look at how this is used by the Cloud Component framework.

 

CCPframework-renderInstance.png

 

When a landing page is rendered the renderInstance endpoint is called with a GET method.  When the endpoint is called:

  1. A GUID is passed though the parameter “{Id}” along with the call.  In addition to the {Id}, the framework can optionally pass the assetId (the Id of the landing page) through the parameter “{AssetId}”,  contactId (if one exists) through “{ContactId}”, and visitorId through "{VisitorId}".  The Provider can then accept these parameters, and use them to do things such as personalize the component, or use the Eloqua API to retrieve further contact information.
  2. The Provider does it's magic, and returns a block of HTML to the Cloud Component framework.
  3. The framework then merges the returned HTML into the landing page code.

 

The marketer would like to remove the component from the landing page, it's time to Remove it from our Provider data store