API Calls in CMS

Starting with CMS release 11-10, you can now leverage Luminate Online server-side APIs by making API calls in CMS.

What can I do with APIs?

Use Luminate Online server-side API calls with CMS to:

• Retrieve Luminate Online user data and display in CMS, such as:

  • Survey statistics

  • Alerts and states of alerts

  • TeamRaiser donor lists

• Check member transaction history

• Embed TeamRaiser functionality in CMS

What APIs can be used?

Only get method and server-side APIs can be used. Server-side APIs are prefixed with "SR."

How do I use it?

Learn more about Luminate Online APIs.

The includeConsId attribute automatically passes the cons_id parameter to the API when making a request.

To pass additional parameters to the API, add them as attributes to the <t:data> tag. For example: <t:data name="openApi" group_id="1000" class="convioApi" apiName="SRConsAPI" method="getGroupMembers"/>

The date format number can also be used if you know the value is coming out as date.

Basic example:

This example pulls constituent data for User ID, First and Last Name, and Email:

<t:data name="openApi" class="convioApi" apiName="SRConsAPI" method="getUser" includeConsId="true"/>
User ID: <t:value id="openApi.getConsResponse.cons_id" />
First Name: <t:value id="openApi.getConsResponse.name.first" />
Last Name: <t:value id="openApi.getConsResponse.name.last" />
E-mail: <t:value id="openApi.getConsResponse.email.primary_address" />

List example:

This example pulls the constituent response from a group:

<pre><t:data name="openApi" apiName="SRConsAPI" method="getUserGroups" includeConsId="true"/>
<t:list id="openApi.getConsGroupsResponse.group" >
    Id: <t:value id="id"/><br/>
    Label: ${label}<br/>
</t:list></pre>