Migration Guide: Transitioning from Booking Partner API

Overview

This guide aims to assist partners in migrating from the legacy Booking Partner API (SOAP/XML) to the new CiiRUS-API (REST/JSON). Transitioning to our modern API architecture offers enhanced performance, scalability, and a simplified integration process. This document outlines key differences, migration strategies, and best practices to ensure a smooth transition with minimal disruption.


API Evolution

The Booking Partner API, built on SOAP and XML, has provided reliable connectivity for years. However, as technology evolves and industry standards shift, we are transitioning to the CiiRUS-API, a RESTful API utilizing JSON for data exchange. This change enhances flexibility, simplifies implementation, and improves overall system efficiency.


Key Benefits of Migrating

Upgrading to the CiiRUS-API offers several advantages:

  • Improved Performance – Faster response times with optimized endpoints.
  • Scalability – Better handling of larger datasets and concurrent requests.
  • Simplified Integration – RESTful architecture with intuitive JSON responses.
  • Modern Development Standards – Aligns with best practices in API design.

With these enhancements, partners can expect smoother interactions, reduced development complexity, and easier maintenance.


Technical Differences

Understanding the differences between the Booking Partner API and the CiiRUS-API is crucial for a successful migration.

FeatureBooking Partner API (SOAP)CiiRUS-API (REST)
Data FormatXMLJSON
ProtocolSOAPREST
Request StructureVerbose, strict schemaFlexible, lightweight
AuthenticationAPI credentials in request body (APIUserName, APIPassword)Basic Authentication (Base64-encoded APIUsername:APIPassword in the request header)
Response HandlingXML parsing requiredJSON parsing

Developers will need to familiarize themselves with these differences to effectively adapt their integration strategies.


Migration Strategy

To facilitate a seamless transition, we recommend the following approach:

  1. Review Existing Integrations – Identify endpoints and data structures that need to be updated.
  2. Update API Calls – Refactor requests to use the new RESTful endpoints and JSON formatting.
  3. Test in a Staging Environment – Validate responses and ensure functionality aligns with expectations.
  4. Incremental Deployment – Migrate features in phases to minimize disruptions.
  5. Monitor & Optimize – Track API performance and address any issues post-migration.

📘

Incremental Migration Approach

It's important to note that partners have the flexibility to adopt an incremental approach to their migration plan. While full migration is an option, partners can choose to migrate specific functionalities gradually while the Booking Partner API remains supported. For instance, they can start by migrating individual components, such as unit details or reservations, while the rest of the integration continues to utilize the existing integration. This allows partners to engage in a controlled, phased migration strategy, minimizing disruption and ensuring a seamless transition.


Compatibility and Testing

To ensure a successful migration, partners should:

  • Conduct thorough testing in a staging environment.
  • Follow the steps outlined in the CiiRUS-API Certification Guide for validation.
  • Verify compatibility between their system and the new API structure.

Developer Resources

We provide extensive resources to support your migration:

  • CiiRUS-API Documentation – Comprehensive details on endpoints, request formats, and responses.
  • Migration Guides – Step-by-step instructions for transitioning specific functionalities.
  • Code Samples – Ready-to-use examples for implementing API calls.
  • Dedicated API Support – Contact our team at [email protected] for assistance.

By following this guide, partners can ensure a smooth and efficient migration to the CiiRUS-API, unlocking enhanced performance and future-proofing their integration. 🚀