Welcome to the CiiRUS-API documentation! This guide provides an overview for new and existing partners looking to integrate with the CiiRUS-API. Whether you're migrating from a legacy system (like our SOAP-based API or the v2023 Partner-API) or connecting for the first time, this is your one-stop resource to understand what’s possible, where to begin, and how to succeed with your integration.

🔍 Overview of the CiiRUS API

CiiRUS supports a wide range of integrations for:

• Channel Managers and Booking Platforms (e.g., NextPax, Hopper Homes)
• Pricing Tools (e.g., Wheelhouse, PriceLabs, Beyond)
• Analytics Providers (e.g., KeyData)
• Smart Lock Providers (e.g., RemoteLock, Lynx)
• Guest Experience Platforms (e.g., Enso Connect)
• Custom Applications built by property managers or tech vendors (e.g., RealTech Webmasters, Intercoastal Net Designs)
• And more, these are just some of the common integration types supported by CiiRUS, and are not an all-inclusive list. If you don't see your integration type, please reach out to our team to discuss your integration so we may assist further.

The CiiRUS-API is a RESTful interface that supports secure, scalable, and flexible access to unit data, availability, reservations, pricing, and more.

🧭 Start Here: Orientation & Key Links

Before diving into endpoints, we recommend first reviewing the following foundational resources:

• 📘 Partner API Introduction
• ✅ Steps to Success
• 🔄 Suggested Workflow
• 🆕 What’s New in the CiiRUS API

These pages explain the high-level architecture, typical partner flows, and the latest feature updates.

🛣️ Choose Your Path

Depending on your use case, business needs, and integration history, your starting point may differ slightly:

🧱 New Partners (First-Time Integration)

If you're building your integration from scratch:

1. Review the Suggested Workflow to understand a typical partner workflow.
2. Begin by following the 4 easy Steps to Success to register and receive your API credentials and test account details.
3. Start development with core GET endpoints:
   1. suppliers
   2. units
   3. unit_details
      1. unit_amenities
      2. unit_images
   4. reservations
   5. unit_calendars
   6. unit_rental
4. Familiarize yourself with our Certification Guide and any additional testing that may be required to meet your integration needs.

🔁 Migrating from a Legacy API

If you're already using our legacy SOAP-based Booking Partner API or the v2023 Partner-API, you can follow our migration plan:

• 📚 Migration Guide
• 🔁 Function Comparisons
• 📅 Migration Plan
• 🛠️ Development Guide

These resources compare old vs. new capabilities, map endpoints, and provide development guidelines.

📘

Use /unit_quotes for real-time rates and availability based on arrival and departure dates — this ensures you always display accurate, bookable pricing.

Use /unit_rental if you only need base rate info or are building rate tables.

🔐 Authentication & Access

To begin using the CiiRUS-API, all API requests must use Basic Authentication. Credentials will be issued to you upon completion of the Steps to Success in the Welcome email sent to you by our team, and are composed of an APIUsername and APIPassword.

🔑 How to Authenticate

All requests to the API must include an Authorization header using the following format:

Authorization: Basic Base64{APIUsername:APIPassword}

Where APIUsername:APIPassword is a plain-text string (with a colon : between the two), then Base64-encoded.

For example, if your credentials are:

APIUsername: NewPartner
APIPassword: MySecretPassword123

You would encode:

NewPartner:MySecretPassword123

Which results in the header value:

Authorization: Basic TmV3UGFydG5lcjpNeVNlY3JldFBhc3N3b3JkMTIz

🚧

If you haven't received your API credentials yet, please request API access before proceeding.

🌐 Environment Access

Access to the CiiRUS-API is restricted to whitelisted IP addresses only for security purposes. Once you receive your welcome email and API credentials, please ensure your static IP addresses are provided to the CiiRUS Support team for whitelisting, if they have not already been provided. Requests from unregistered IPs will be rejected and return a 403 Forbidden error message. You can review our Error Manual [HERE].

If you are using cloud infrastructure (e.g., AWS, Azure), make sure your outbound IPs are fixed or routed through a static gateway.

🚨 Credentials Are Environment-Specific

• Each set of API credentials is account-specific.
• Do not share credentials across different clients or partners.
• Do not hardcode credentials in public repositories or distribute in client apps.

✅ Authentication Checklist

• Received APIUsername and APIPassword from CiiRUS Support
• IP addresses submitted and confirmed as whitelisted
• Basic Auth header added to all requests
• Using HTTPS for all communications

✅ Certification & Testing

To go live, all integrations must complete a certification:

• Review the Certification Guide
• Certification typically includes:
  • Data synchronization tests (units, details, images, rates, etc.)
  • Availability verification
  • End-to-end test bookings
  • Payment handling confirmation

    👉

    Note: Let us know if you are acting as the Merchant of Record or submitting payments.

📦 Supported Use Cases by Partner Type

Below are common integration types and some of the typical endpoints and features used when integrating with the CiiRUS-API. These are general examples — integrations are flexible and can be customized depending on your business needs.

🚧

This list is not exhaustive, these are just some of the most common integration types — the CiiRUS-API supports a wide range of use cases beyond those shown here. If your use case doesn't neatly fit one of these categories, reach out to our API Support Team, we’re happy to advise on a best-fit integration approach.

🧠 Frequently Asked Questions

We’ve compiled answers to the most common questions, from rate calculation logic to API limits and update frequency.

• Check the full FAQ.

A few highlights:

• Q: How often should we poll for changes?
  • A: Availability and rates should be polled regularly. While static unit details can be polled less frequently. For details, see our Suggested Workflow page.
• Q: What happens if a PMC updates rates or content?
  • A: The Agent is expected to ingest these updates regularly—most partners poll or cache data based on configurable intervals.**
• Q: Can we ingest only the changes instead of the full dataset?
  • A: In most cases, yes. Many endpoints support filtering by last_updated parameters — check individual endpoint docs for efficient delta sync patterns. For further details, see our Suggested Workflow page.

📘

For definitions of terms like Agent, Inventory, etc., see the Glossary.

💬 API Support & Contact

If you need help:

1. Review our API Support Guide for steps on how to escalate.
2. Be ready to provide:
   1. Your Account Username or ID
   2. Endpoints used
   3. Request/response samples
   4. Response GUID (x-amz-meta-guid)
   5. Any supporting logs or screenshots

We’re here to help, but the more context you give, the quicker we can assist.

🚀 You're Ready!

With all the resources linked above, you should have a clear roadmap for integrating with the CiiRUS-API. Bookmark this page and check the Changelog regularly for updates.

When you're ready to certify or if you need help choosing the right workflow, reach out to our team.