Access the Open API Configuration Tool

Open API configuration in Luminate Online consists of configuring several different elements to enable the APIs.

Access the Open API configuration tool

1. Log into Luminate Online as a site administrator.

2. Go to Setup > Site Options.

3. Click the Open API Configuration tab.

   

A screen shows the configuration status of the Luminate Online API options. Some options are automatically configured by the Open API Configuration tool. Configured options display in green next to a check mark. Options that are not yet configured display in red beside an "X."

Note: Not all options must be configured for all API access methods.

Next to each section, click the link to access settings:

• Configure API Keys -- Configures your site for client-side or server-side REST-style API access and for Luminate Online Web Services access. See Open API Keys.

  Note: To use server-side REST-style APIs, you must also define the options under the Configure API to allow server access section. Certain special characters in the API Key will cause in an "Incorrect API key" error during use. Avoid using these characters: & : \ " ' ? =

• Configure API to allow server access -- Lists the addresses of servers authorized to access the Luminate Online Open APIs (Server), and creates API administrative accounts to control access via Luminate Online Open APIs (Server) and Luminate Online Web Services. See Open API Server API Configuration.

• Configure JavaScript access to Open APIs -- Controls cross-domain access from web pages containing the Luminate Online Open API JavaScript class library. See JavaScript Configuration.

• Configure AJAX proxy service -- Designates external domains to which Luminate Online may proxy AJAX JavaScript requests. See AJAX Proxy Configuration.

• Configure Luminate Online Web Services -- Configures the Luminate Online Web Services SOAP-protocol APIs. See Luminate Online Web Services API Configuration.