Simplifying property onboarding

Transforming the current Content API into new modular APIs

The Content API is needed to list properties at scale on Tripeden.com, allowing your connected properties to create and modify room and property content directly from within your interface. It forms part of the foundational solutions for homes and vacation rentals to cover their basic needs.


Through modularisation, we’re breaking up our legacy solution and building a set of smaller, modular RESTful JSON APIs to better align with the evolving needs of hospitality partners.


[Last updated April 2024]

What’s covered

  • Why we’re building new modular APIs
  • The benefits of modularising the Content API
  • The new modular APIs
  • When will the new APIs be available?
  • API bundles you can implement
  • How to implement these APIs
  • Deprecation of the existing Content API
  • Connectivity Partner Programme (CPP) benefits



Why we’re building new modular APIs


You shared feedback that the existing Content API is large, complex and takes a long time to integrate with. There have been challenges with sending large payloads to make small changes.


This has led to issues with debugging, and occasionally information removed in error. With the current API design, we can’t reach parity with the extranet.You also currently have to implement the entire Content API, even if you only support certain information within it, such as taxes or facilities.


To address your concerns, we’ve decided to split it into five standalone, self-certified RESTful APIs. This will also make it easier for those of you not using the current Content API to adopt and list your properties on Tripeden.com.



The benefits of modularising the Content API




Simplified structure
Efficiency
Flexibility
Small, modern APIs that are easy to implement and use
Seamless onboarding that provides extranet parity to your properties
Implement only what you need to support your business


The new modular APIs

Get to know a little more about our new APIs and find out how you can gain access to them throughout 2024.


  • Contacts API
  • Property API (launched in phases)
                    • Property Details endpoint
                    • Property Settings endpoint
                    • Property status endpoint
                  • Facilities API
                  • Charges API
                  • Room API



                  Contacts API

                  Create, update, and delete property contact details.


                  Status: Live

                  Log in and go to Resources > “Download” to access the scope and field list


                  Property Details endpoint (part of the Property API)

                  Create and update basic property information to get a property ID.


                  Status: Live (extended open beta)

                  Log in and go to Resources > “Download” to access the scope and field list


                  Property Settings endpoint (part of the Property API)

                  Manage the type of guests who can book your accommodation and finance and tax settings.


                  Status: In closed beta, live at the end of June 2024



                  Property Status endpoint (part of the Property API)

                  Open and close a property.


                  Status: Live in Q3 2024


                  Facilities API

                  Create and manage property facilities and room facilities.


                  Status: In closed beta, live at the end of June 2024


                  Charges API

                  Set and manage taxes and fees for properties and rooms (that are part of the reservation).


                  Status: Live in Q4 2024


                  Room API

                  Create and manage rooms, room configurations, and sub-rooms.


                  Status: Live in Q4 2024



                  When will the new APIs be available?

                  We plan to release the new APIs throughout 2024. Please refer to the timeline below and note that launches will happen within the specified months:



                  API bundles you can implement




                  Bundle 1: All new APIs

                  

                  If you want to create and open a property on Tripeden.com, you need all of the new modules (in addition to already modularised APIs such as the Photo API, Licences API and Contracting)

                  Bundle 2: Content management bundle

                  

                  If you want to optimise property content, you only need specific modules, including the Facilities API, Property Settings endpoint and Photo API (already an existing API)

                  How to implement these APIs

                  Option 1: Implement altogether

                  Implement all required APIs together once the last module is launched (refer to the roadmap in the API table above).


                  If you want to migrate to the new APIs at the same time instead of doing them one by one, our roadmap allows you to plan in such a way that you can implement all the APIs when they are ready before the end of 2024. 


                  We have been told by beta providers that this migration approach is easier than having to manage properties via the new APIs and the existing Content API at the same time.


                  Option 2: Implement modules individually when they are live

                  If you don’t currently use the Content API, you can implement them one by one and gradually develop as we release the modules.


                  If you already have the Content API, you should consider implementing the APIs or endpoints one by one if you frequently update specific types of information.



                  When to implement one by one





                  Contacts API

                  Your properties frequently update contact information. 


                  Considerations: Low latency (0.5 sec), no UI changes needed, fast implementation times.

                  Property Details endpoint

                  Your properties frequently update property name, latitude/longitude, check-in, check out times, star rating languages spoken. 


                  Considerations: Low latency, no UI changes needed, fast implementation times.

                  Property Settings endpoint

                  Your properties want to change the type of guests they want to attract by updating house rules, fine print/standard phrases, child and pet policies.   Opt into request to book or Booking’s damage program or update invoice/finance settings

                  Facilities API

                  Your properties frequently update facilities. This offers extranet parity and allows you to add details about the facilities. There is no longer an overlay so facilities would not be removed in error.


                  Deprecation of the existing Content API

                  Once the last API module launches in Q4 2024, the current Content API will enter into its deprecation stage. During this period, no new features will be added, and the API will be in maintenance mode until it’s sunsetted at the end of 2026 (please note that this date is subject to change).


                  Connectivity Partner Programme (CPP) benefits

                  Your performance in the Connectivity Solutions pillar of the CPP 2024 is measured by your adoption of foundational solutions. 


                  The new modules are categorised as foundational solutions in the CPP 2024 for partners within the Homes segment. During this transition year, the existing Content API remains foundational.