Luminate Online Web Services API Configuration
To configure your Luminate Online system for use with
Luminate Online Web Services:
- Log in to Luminate Online as a system administrator.
- Go to Setup on the menu, and choose Site Options.
- On the Site Options screen, click the Open API Configuration tab.
A dashboard screen will open showing the configuration
status of the various Luminate Online API options. Under the section heading
Configure API Keys
click on the link Edit API Keys. Enter a value in
the Luminate Online API Key field and click the Finish button.
Next, under the section heading Configure Luminate Online Web Services
click on the link Edit Web Service configuration.
On this screen the system administrator must specify the
IP range of servers allowed to access Luminate Online Web Services. The
administrator can also quickly generate a default partition of
the Luminate Online database for access through Luminate Online Web Services,
restricting access to data on only those constituents who are
not site administrators.
Options on this page include:
- Luminate Online Web Services URI -- Set this
field if the Luminate Online Web Services process runs on a separate
system from the Luminate Online Website. Otherwise, leave this field
blank.
- Luminate Online Web Services IP White List --
Designates servers which may access Luminate Online Web Services
using
CIDR
notation. To permit access from single IP address,
use a 32-bit mask value (e.g. 192.168.1.100/32).
To permit access from all addresses on a class-C subnet,
use a 24-bit mask (e.g. 192.168.1.0/24).
- Add Current IP Address to list --
Optionally, use this button to automatically add the IP
address of the system on which you are running the Luminate Online
Admin application to the White List.
- Remove Selected IP Range -- Use this
button to remove servers from the IP White List by clicking
the server's IP range in the list to highlight it, then
clicking the button.
- Create Default Partition -- You must
create a partition for Luminate Online Web Services. Click the
Create button to automatically create a
default database partition that may be accessed via Luminate Online
Web Services. The default partition includes data for all
constituents except for administrator accounts. If you prefer
to use a custom partition, you must set up a custom partition
by clicking Data Management on the main
menu, selecting Import/Export, and choosing
the Partition Management tab.
Note: IP restriction for Luminate Online Web Services access includes the
local host. If you wish to permit web services console access to CWS running
on the same host, you may need to include the local host address (i.e.
127.0.0.1/32) in the IP white list.