A while back we released the eCommerce SDK for CloudPortal Services Manager 10, and now it comes as an integral part of CloudPortal Services Manager 11.  This SDK allows third parties to integrate billing and eCommerce solutions with the CloudPortal Services Manager (CPSM) product.  In particular, it offers an easy way to query customers and products (aka Services and Plans) and view their usage on a daily basis.

The eCommerce SDK is designed as a set of 2 RESTful APIs, one to query the configuration state and one to query the usage.  Because it uses RESTful principles it can be used from any computer, any programming language, any OS, and can easily traverse firewalls.

The SDK comes with a set of PowerShell scripts that serve as code examples for how to query the 2 eCommerce APIs. We also include a “How-To” guide for querying the Usage API using HTML/Javascript. To complement that, I’m happy to announce that we’ve also just released some sample code showing how to use the Configuration API via HTML/Javascript.

Sample Javascript Code for eCommerce SDK

This code was actually used internally as a little test framework — a quick way for developers to test the API and make sure it was working.  We’ve also used it a couple of times when doing customer engagements to debug a deployment.  In other words you can benefit from it not only by looking at the code sample but also use it to see the health of your system.

Deployment

It comes as a zip file. Simply unzip it next to the eCommerce code.  For instance for CPSM 11 that means you might unzip it to c:\inetpub\Cortex Management\eCommerce\v1\Test\.

You can then access it by simply appending “test” to your eCommerce URL path.  Again, for CPSM v11 that means you might be able to access it from https://cortexweb/eCommerce/v1/test/.

Once you do so you should see a screen similar to the following:

Image of eCommerce Test Page

Usage

Type in your CPSM credentials at the top of the screen, then navigate to any of the links. From there the functionality is fairly self-explanatory.

This doesn’t replace the full documentation, which is installed automatically, but it does help you if you would prefer to code against the eCommerce SDK with web technologies instead of PowerShell scripts.  Enjoy!