Getting Started with the Allora CRM Module API

Audience

This document is intended for use by hoteliers and their development teams that wish to connect to Allora CRM™ for use in external systems.

The reader should be familiar with technologies supporting JSON.

Product Overview

The API enables web-based CRM functionalities within the hospitality industry to connect directly to the Allora CRM properties to:

• Create, modify and search guest profiles

• Add, manage and remove credits from guest profiles

The CRM will return a response to each request in a synchronous mode which is simply defined as a request / response over the same channel.

Document Overview

The CRM API Swagger documentation is separated into sections based on each function of the interface.

The documentation defines the business rules, supported data elements and the expected behavior of participating systems, and should be used as a guide to developers for implementation of message sets.

Web Services

The participating partner site/channel will be provided with the web service that enables the partner to send messages to the CRM.

Authentication

Participating partners will be obligated to provide appropriate credentials when using the CRM web services. These will be granted as part of the certification process. Credentials include:

• System ID – a unique identifier of the partner organization

• User Name [ID] – a unique login name for authentication

• Password – a secure password corresponding to the user name