Configure your Site for Luminate Online Open APIs

To use Luminate Online Open APIs, including Luminate Online Web Services, you'll need to complete some site configuration to enable and control API access. The Open API Configuration tool for site administrators performs some automatic configuration and assists with manual configuration of a site for API access. The tool also manages cross-domain access to the Open APIs from JavaScript clients and allows logging of Open API calls and downloading/viewing of log files.

The API and Web Services documentation is available at http://open.convio.com/api/#main.

Warning: Administrators added to the API Administrators group will not be able to log in to Luminate Online. See KB 68207.

Luminate Online Open APIs and Luminate Online Web Services permit clients to integrate features and functionality of the Luminate Online platform into other web server applications or web page content. These APIs can be divided into main categories based on how they are accessed. Each category offers slightly different features and has different configuration requirements. These three categories are:

  • Luminate Online Open APIs (Client): REST-style APIs intended to be accessed directly from a constituent’s web browser using client-side scripting. These APIs are the easiest to use, requiring no server-side programming. They are typically called either in the session context of a logged-in constituent or as an anonymous user. The information they can access is limited to protect the privacy and security of client and constituent data.

  • Luminate Online APIs (Server): REST-style APIs for use by other application servers. Some are administrator-context corollaries to the Client APIs described above. These APIs respond only to secure requests from trusted IP addresses, and require valid API Administrator credentials with each request. As such, they are able to expose more functionality than anonymous client APIs can.

  • Luminate Online Web Services: SOAP-protocol APIs for use by SOAP consumers such as .NET or Java enterprise servers. These are the lowest-level APIs exposed by the Luminate Online platform and as such require session security. Originally designed to provide Data Synchronization services, these versatile and powerful APIs can also be used for other purposes.

The Open API Configuration tool enables a site administrator to easily configure access for any or all of these API categories.