Configure and Test Server Luminate Online Open APIs

This scenario describes how to set up and verify configuration of the Luminate Online Open APIs (Server) on your Luminate Online site. This tool automatically sets up an API Key, that you can modify. You will supply this key when invoking the Client APIs. You also have to specify the IP addresses of the servers permitted to access these APIs in the IP White List, and create one or more API Administrator accounts to use when accessing the Server APIs.

  1. Log in to Luminate Online as an administrator.

  2. Go to Setup > Site Options.

  3. Click the Open API Configuration tab.

  4. In the Configure API Keys section of the dashboard view, note the value of the API Key You must supply this value in the api_key parameter when calling any of the Luminate Online Open APIs.

  5. In the "Configure API to allow server access section," click the Edit server API configuration link.

  6. In the Luminate Online API IP White List section, add the IP address ranges for any servers that will use the Server APIs.

  7. To test the Server API configuration, also add your own IP address by clicking the Add Current IP Address to List button (you can remove it later).

  8. Under Manage API Administrative Accounts, add at least one user as API Administrator. You must supply an API Administrator user’s credentials in the user_name and password parameters of all Server API calls.

  9. Click Finish to complete the Server API configuration.

  1. If you have not done so, add the IP address of your test system to the Luminate Online Open API IP White List as described above.

  2. Determine your Luminate Online site’s POST URI. One way to do this opening your Luminate Online site’s Login form in a browser.

    1. Open your Luminate Online site’s Login form.

    2. Select View->Source from the browser menu.

    3. Search for the <form action= tag. It will contain a URI that resembles

      https://secure2.convio.net/yoursite/site/

  1. Modify this URI, appending the name of the Constituent Server API:

    https://secure2.convio.net/yourSiteName/site/SRConsAPI/

  1. Copy the following into a text file, and change the FORM action= attribute to the correct POST URI for your server:

    Note: The following form is intended only for testing your API configuration. Do not include login_user and login_password credentials on a site web page where the credentials would be visible to an attacker. Server API calls are permitted only from white-listed systems to your Luminate Online site.

    <HTML>

    <FORM

    action="https://secure2.convio.net/yourSiteName/site/SRConsAPI/"

    method="POST" >

    Method: <INPUT name="method" type="text" value="listUserFields"><BR />

    Version: <INPUT name="v" type="text" value="1.0"><BR />

    API Key: <INPUT name="api_key" type="text" value=""><BR />

    API Admin User: <INPUT name="login_user" type="text" value=""><BR />

    API Admin Password: <INPUT name="login_password" type="text" value=""><BR />

    <BR />

    <INPUT type="submit" value="Send">

    </FORM>

    </HTML>

  2. Save the file with an HTML file extension.

  3. Open the file in your browser.

  4. Fill in the API Key, API Admin User and API Admin Password fields from steps 4 and 8 of the site configuration, above.

  5. Click Send. If your Server API configuration is correct, you will see a response similar to the following:

- <listConsFieldsResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

- <field>

<name>accepts_postal_mail</name>

<label>Accept Mail</label>

<required>false</required>

<valueType>BOOLEAN</valueType>

</field>

- <field>

. . .