clarence-chester v1.0.0

Getting Started with Channel Management API

Introduction

Before beginning work it is necessary that:

• Your organization is registered and activated
• You have participated in a kick­off meeting
• The opening questionnaire has been filled out
• You have your login and password. (Using it you get a unique session token that must be used in every request to API as param jwt)

Contact us to be registered and get your credentials.

All responses are returned as JSON.

This document covers all the API calls and other methods that can be used to complete Razor-Cloud integration. It is important to note that all parameters are case sensitive in this document and should be used as documented.

Responses: When a request is successful, a response body will typically be sent back in the form of a JSON object. An exception to this is when a DELETE request is processed, which will result in a successful 200 status and an empty response body.

Install the Package

Run the following command from your project directory to install the package from npm:

npm install clarence-chester@1.0.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

const client = new Client({
  timeout: 0,
  jwt: 'jwt',
})

Authorization

This API uses Custom Query Parameter.

List of APIs

• Authorization
• Property Managers
• Product
• Images
• Rates and Availability
• LOS Pricing
• Fee and Tax
• Fee and Tax Mandatory at the Property Level
• Yields
• Validation
• Testing of Message API Calls
• Messaging
• Request to Book
• Push Notification
• Reservation Notifications

Classes Documentation

• ApiResponse
• ApiError