Search

 

Version: 5.1 +

Applicable to: Futurama Webservice

 

Description

At the Futurama Web API page is explained how to use Futurama Web API to integrate Futurama web content with your Content Management System. To use the Futurama Web API in the web.config of webservice a webapi futuramaSettings setting has to be included. At this page is explained how this can be configuerd.

Configuration

Settings

Within the configuration element the next code has to be included:

<configSections>
	<sectionGroup name="futuramaSettings">
		<section name="webAPI" type="ActuIT.Futurama.Config.WebAPISection, ActuIT.Futurama.Engine, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"/>
	</sectionGroup>
</configSections>

Next to this code, also within the configuration element the next code has to be included:

<futuramaSettings>
	<webAPI enabled="{Enabled}" includeExceptionDetails="{ExceptionDetails}" localPathSubstitutionUrl="{ReplacementURLFormat}"/>
</futuramaSettings>

Explanation

Within the map element some attributes can be set. Below the possible values of these attributes.

enabled

Indicates whether the WebAPI functionality should be enabled. Notes:

  • This attribute is optional. If this attribute is not included the default value is used.
  • Possible values are 'true' or 'false'.
  • the default value is 'false'.
replacementURLFormat

Local addresses that are rendered to the output XHTML source code might not be accessible from a front-end-client's perspective. That is why all XHTML elements that contain a local link within the 'src' attribute are rewritten to correspond to a new URL. It's up to the developer to make sure this URL points to a pass-through system, that can use the data and sessionid that is stored within the new URL to get data from Futurama WebAPI. Notes:

  • This attribute is optional. If this attribute is not included the default value is used.
  • The default value is "MyTunnel.aspx?data={data}&sid={sessionID}".
  • The URL must contain the texts "{sessionID}" and "{data}", which indicates where in the url the encrypted data, and the sessionID should be placed.
  • The URL must be reachable for the client of the Front-End.
exceptionDetails

Indicates in whether a thrown error should include deeper technical details,  Notes:

  • this attribute is optional. If this attribute is not included the default value is used
  • the default value is 'false'
  • Possible values are 'true' or 'false'.
  • This might be very useful for debugging, but is highly undesirable when the website is published.

Feedback

If you have any questions about this subject or if you want to provide us feedback please send us an e-mail.

Updated: 2016-07-29