Open API Server API Configuration

Designate which external systems have access to Luminate Online Open REST-style APIs by adding them to the Luminate Online API IP White List.

Note: The IP White List only permits access to the Luminate Online Open API (Server) REST-style interfaces. Luminate Online Web Services SOAP APIs use a different IP White List, and Open API (Client) interfaces allow connections from any IP.

Available options are:

  • Add New IP Range to List -- Specify the IP Range for servers authorized to access the Open API (Server) interfaces using CIDR notation.

  • Add Current IP Address to list -- This button adds the IP address of the system that runs the Luminate Online Admin application to the whitelist. This is useful for testing.

  • Remove Selected IP Range -- This button removes selected server IP ranges from the whitelist.

  • API Administrative Accounts -- Set up accounts for both the Luminate Online Web Services SOAP APIs and to the Open API (Server) REST-style APIs. These are not used by the Open API (Client) REST-style APIs, which may be accessed anonymously. These accounts are automatically added to the API Administrators Group.

    1. Access the Open API Configuration.

    2. For Configure API to allow server access, click Edit server API configuration.

    3. In the Luminate Online API IP White List section:

      1. For Add New IP Range, enter the new IP address.

      2. Click Add New IP Range to list. A list of IP address that are whitelisted display in Current IP Ranges.

        Note: To add your current IP address, click Add Current IP Address to list.

    4. Click Finish.

    1. Access the Open API Configuration.

    2. For Configure API to allow server access, click Edit server API configuration.

    3. In Luminate Online API IP White List, select the IP addresses that you want to remove under Current IP Ranges.

    4. Click Remove Selected IP Range.

    1. Access the Open API Configuration.

    2. For Configure API to allow server access, click Edit server API configuration.

    3. In Manage API Administrative Accounts, enter information for each admin account that will be used in the API calls:

      1. User Name

      2. Password

      3. First Name

      4. Last Name

      5. Email Address

      Note: Use a unique account for each system that will access the APIs.

    4. Click Finish.

Privileges granted the API Administrative Accounts group through the Open API (Server) and Luminate Online Web Services interfaces may be administered elsewhere.