CiiRUS-API Introduction

Different Sections of the Document

The CiiRUS-API enables partners to efficiently manage listings and reservations for Property Managers connected with CiiRUS. With the CiiRUS-API, you can retrieve comprehensive listing data, including availability, content, and rates, as well as manage pricing rules, reservations, and more.

We are committed to continuous improvement, regularly adding new features and updating existing tools to meet the ever-changing needs of our partners and mutual customers. Rest assured that any updates will always be communicated to you in advance, ensuring a seamless integration experience.


CiiRUS-API Documentation

The CiiRUS-API Documentation (CiiRUS-API Docs) provides all the resources necessary for a smooth integration. It includes comprehensive Guides, detailed API Documentation, and a Changelog.

Guides

The Guides section introduces core API concepts, workflows, and example requests and responses. These guides help you structure your integration effectively. You can also use the built-in search function to quickly find specific details.

API Documentation

The API Documentation provides a full list of endpoints, parameters, and response structures. This resource is essential for understanding the correct request formats for different API functionalities.

❗️

Important

Avoid using the built-in "Try It" feature in the API Documentation for making requests. Due to conflicts between API security measures and the design of the API Explorer, built-in requests are currently not compatible. Instead, we recommend using the API documentation to structure your requests and testing them with Postman or a similar tool from a whitelisted source.

Additionally, the API Documentation operates in the production environment, meaning all requests immediately affect live data. Exercise caution to avoid unintended modifications to Supplier listings.

We recommend:

  • Using the API Docs to understand request structures.
  • Testing with CiiRUS, Inc. hosted Test Properties before moving to production.
  • Verifying all requests before execution to prevent unintended data changes.

Changelog

The Changelog is your go-to resource for staying informed about any significant changes made to the CiiRUS-API. We use this page to notify you of important updates, including API improvements, deprecated parameters, and the addition of new features. By regularly checking the Changelog, you can ensure that you are always up-to-date with the latest changes and enhancements to the CiiRUS-API.


What’s Next