Servlet URL

The Luminate Online APIs are ReST-style APIs, invoked by passing form data in an HTML POST or GET request to the servlet URL of the API.

In most cases, secure2.convio.net or secure3.convio.net matches a client's secure domain. However, in some cases, a client will have their own branded secure domain and this will be different. If your organization uses Luminate Online for fundraising, the correct secure domain for the API is identical to the secure domain for your fundraising forms. So if the sample above does not work, look for the unique secure domain used for your organization and replace the secure2.convio.net portion above with this URL.

Here, organization is a client's unique identifier in the system. Every client has a unique value that represents their instance of the product. If your organization uses a custom secure URL for donations, the organization portion of the URL may not be necessary, contact support for assistance.

The site part of the URL indicates which channel ("site" versus "admin") the API is to use to authenticate a logged-in user's session. Generally you will use the "site" channel, however, if you are extending the Luminate Online Admin user interface via a client-side API, you should use "admin" instead, since Admin users log in via this channel. The following servlets support the use of "admin" channel URLs: CRAdvocacyAPI, CRConsAPI, CRContentAPI, CRGroupAPI, and CROrgEventAPI.

Note: When including an ampersand in the URL, use the ampersand character (&) and not an encoded ampersand (%26).  The encoded ampersand does not return data. The ampersand character (&) does return data successfully.