Configure and test Client Luminate Online Open APIs

This scenario describes how to set up and verify configuration of the Luminate Online Open APIs (Client) on your Luminate Online site. This tool automatically sets up an API Key, that you may modify. You need to supply this key when invoking the Client APIs.

  1. Log in to Luminate Online as an administrator.

  2. Go to Setup > Site Options.

  3. Select the Open API Configuration tab.

  4. In the Configure API Keys section, select the Edit API Keys link.

Note: Remember the value automatically generated for the Luminate Online API Key. You must supply this value in the api_key parameter when calling any of the Luminate Online Open APIs. If you want to use a different key, change the Luminate Online API Key value here.

  1. Select Finish to complete the Client API configuration.

  1. 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 Client API:

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

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

    <HTML>

    <FORM

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

    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 />

    <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 value from steps 5 of the site configuration above.

  5. Select Send. If your Client 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>

    . . .