Lime Light - Gathering API Credentials

In order to enable API Access to Lime Light, the following credentials must be gathered:

  • Admin URL
  • API Username
  • API Password
  • Campaigns

To allow API access, you will need to create a API user in your Lime Light account. To do this, follow these steps:

Creating API Accounts

API Accounts allow you to create custom API users within your CRM. In order to create an API user, just go to Admin Settings >API Accounts. Once there, just click on “Add API User” in order to create a new user account.


*NOTE*-  Please keep in mind that if you see the message "This order was placed by unlinked API user", it just means that the user has not been updated to include the newly added user data fields.  The API account access/functionality hasn't changed, we just can't pull full reports on that user's API calls. Adding this additional information will allow for more meaningful analysis of API activity.

For API accounts that you have already created, you can search for them by Id or a list of Id’s by entering the search criteria in the search field. The system will automatically populate the results for you once the search criteria is entered.

The API Accounts page will be available to users who are assigned to the administrator and technical departments within your system. An API password will automatically be generated by the system once a username is created for your API user. The API username and password that is generated can then be used in conjunction with our Transaction and Membership API. There is no limit on the number of API users that can be created in your system.   

API Account Permissions

When you edit the permissions for an API user, the API Account Permissions page will allow you to enable or disable API methods for an API user. Examples of the permissions that can be set within our Transaction and Membership API are listed below.

Campaign Permissions

On the API Account permissions page, you have the ability to restrict or allow certain campaigns for your API Users; just select edit next to campaign permissions in order to set these permissions.

Enable the following permissions:
order_find, order_view, order_update, campaign_find_active, validate_credentials

All other permissions can be disabled.