Sunday, June 28, 2015

Using the Ektron Framework API (service) from command line or application

The Ektron Framework API provides an interface to interact with an Ektron web site - this may be via another web site or in an application of some kind. Using the service you can access content, users, commerce, settings, search and so on using CRUD (Create, Read, Update and Delete) commands.

Ektron has provided a console application which leverages this framework API, which can be found here. This particular sample is made to work with version 9.1 of Ektron, however it should easily work with any later versions.

Getting the sample solution working

  1. Replace the DLL files with latest versions
    1. Remove all references from the solution
    2. Add the refrences again from the following path: C:\Program Files (x86)\Ektron\CMS400v91\startersites\3TierMin\Content\bin
  2. Replace the ektron.cms.framework.unity.config and instrumentation.config files
    1. The replacements can be found in: C:\Program Files (x86)\Ektron\CMS400v91\startersites\3TierMin\Content
  3. In the app.config change the "ek_ServicesPath" variable to the location of your Ektron installation
  4. In the main program class file, you will need to enter admin credentials to authenticate with the CMS.
The sample solution should then build and when run will create a piece of sample content. From here you are able to modify the code to interact with the Ektron Framework API as required.

No comments:

Post a Comment