Configuring API Access for the Web Component

The UNIFYBroker Web Component operates the UNIFYBroker service through an API. By default, the UNIFYBroker Web Component is configured to use the default UNIFYBroker API. If the UNIFYBroker API is reconfigured, the Web Component must also be reconfigured to use it correctly.

Configuration

To configure the API used by the Web Component, open the Web.config file and make the following changes:

Inside the appSettings element in the configuration element, find the following element:

<add key="apiAddress" value="{apiAddress}" />

and update the {apiAddress} to match that of the desired API.

If the desired API has authentication configured, the following elements must also be configured:

<add key="api:AuthorizeSetting" value="AADBearer" />
<add key="api:Tenant" value="{Tenant}" />
<add key="api:AADInstance" value="https://login.microsoftonline.com/{0}" />
<add key="api:UIServiceResourceId" value="{UIServiceResourceId}" />
<add key="api:UIClientId" value="{UIClientId}" />
<add key="api:UIAppKey" value="{UIAppKey}" />

The above five settings should be configured as follows:

NameDescription
TenantThe tenant setting of the target API.
UIServiceResourceIdThe audience setting of the target API.
UIClientIdThe ID of the client application representing UNIFYBroker.
UIAppKeyThe secret key from the client application representing UNIFYBroker.

Is this article helpful for you?