Content API Modularisation
Our current Content API, integral to property onboarding, management and performance on Tripeden.com, allows your connected properties to create and modify room and property content directly from within your interface. Now, through modularisation, we’re splitting our legacy solution into smaller, modular APIs to better align with the evolving needs of hospitality partners. Over the past few years, we’ve already extracted functionalities like photos, property profile and licences to separate APIs, marking early steps in the modularisation. Each new API will have its own set of well-defined features, giving you the flexibility to choose what you want to implement based on your business needs. These standalone RESTful APIs will be easier to implement, understand and use, with minimal maintenance and clear technical documentation. They will collectively replace the HDCN, HIN, and HDI endpoints of the original Content API, which are set to be deprecated and sunsetted at the end of 2026, though this timeline may be subject to change.Enjoy a new set of modular APIs and endpoints
[Last updated: 16 November 2023]
What are the problems we’re solving?
Updates and overlay
We currently offer a lot of functionalities through a few major endpoints. When you update property details, fees, facilities and more, information is often sent in an overlay. That means that we send large requests for relatively small changes, which can result in errors.
Lower adoption
You’re currently required to adopt the Content API as a whole. Due to this, some Connectivity partners haven’t adopted it and their property partners can’t optimise their listings. This is especially problematic for multi-provider connection and specialised partners who only support certain content.
Long development time and high investment
The Content API is difficult and time-consuming to implement due to its complex nature. Adding new features to the existing endpoints would make it even more complicated for our partners.
What are the benefits of the Content API Modularisation?
Speed
The new, smaller APIs and endpoints are easier to develop, test and debug. This allows us to ship new features faster to you.
Separation of concerns
Each API is responsible for a well-defined, limited set of features, allowing you to update one object without touching the rest.
Solving overlay
You’re able to update one piece of information within a particular object without changing anything else.
Enhanced product features
The new APIs will support new functionalities to give you more control.
Flexibility
You can implement the specific APIs you need based on your business.
What will the new APIs and endpoints be?
Property API
- Property Details endpoint
- Create and update basic property information and get a property ID
- Fields including: Name, address, property type, languages spoken, number of rooms, number of floors, check-in/check-out
- Property Settings endpoint
- Manage property settings and rules such as opt-ins and property flags
- Fields including: Standard phrases/fineprint, house rules, accepted guest type, age restrictions, pets allowed, accepted payment types, accept longer stays, damage policy
- Property Status Management endpoint
- Manage open/close status of property and check that it fulfils the requirements to be open and bookable
- Property Search endpoint
- Check the status, date of last change and creation date of properties to determine pending connection status and build from Tripeden.com
Contacts API
- Create, update and delete property contacts
- Fields: Name, email, phone, address, type
Facilities API
- Property Facilities endpoint
- Create and manage facilities, services and activities on a property level
- Fields: Facility ID and facility details
- Room Facilities endpoint
- Create and manage facilities on a room level
- Fields: Facility ID and facility details
Room API
- Room Details endpoint
- Create and manage rooms and room configurations, including bedding
- Fields including: Room, room type, occupancy, size, room config including subrooms and alternative arrangements, beds
Charges API
- Taxes endpoint
- Set and manage taxes for both properties and rooms
- Fields including: Tax code, amount, included/not included in price of the stay, charge frequency (per night, per stay)
- Fees endpoint
- Set and manage property and room fees
- Fields including: Fee code, amount, included/not included in price of the stay, charge frequency (per night, per stay)
What are the benefits for each API and endpoint?
Overall benefits
- Overlay behaviour removed: send what you want to change, meaning less information removed in error, smaller payloads and fewer database issues
- Clear update behaviour: different endpoints for create, update and delete
- Unified read and write behaviour
- Improved organisation of information/logical grouping of information
- New APIs built to modern JSON standards
- Clear, complete documentation including validations and field behaviour
- Standalone API: implement desired APIs without supporting other content
Property Details endpoint
- Early and enhanced duplicate check, providing more info on the duplicate
- Consolidated related fields from across the payload
- Clearer structure for setting addresses and translations
- Additional product features including property URL on guest website and external property ID
Property Settings endpoint
- Organised in one place
- Flexibility, with many small objects allowing us to add new settings which will be returned in the read call
- Individual settings can be updated, with nothing else being removed from the extranet
- New settings added that aren’t currently supported by the Content API
- Gives access to settings related to ARI without having to implement the entire Content API
Property Status Management endpoint
- New endpoint in JSON
- But can keep sending in XML if preferred
Property Search endpoint
- New endpoint in JSON
- But can keep sending in XML if preferred
Contacts API
- Less duplication of data, whereby the same contact can be used for more than one contact type
- No need to update and clone contacts in bulk via the internal operations team
- Relatively low effort since there are no field name changes
Property Facilities endpoint
- Communicate more information about facilities, such as parking or the temporary close dates of a swimming pool
- All facilities available via the API
- Extranet parity and quick identification of any new facilities added
- Manage individual objects (facilities instances) independently, thus eliminating the undesired removal of facilities by overlay
- Rationalisation of outdated facilities
- Parking and internet classified as facilities
- OTA codes used wherever possible
Room Facilities endpoint
- Communicate more information about facilities, such as bathroom or crib details
- All facilities available via the API
- Extranet parity and quick identification of any new facilities added
- Manage individual objects (facilities instances) independently, thus eliminating the undesired removal of facilities by overlay
- Rationalisation of outdated facilities
- OTA codes used wherever possible
Room Details endpoint
- Clarity on room and sub-room behaviour
Taxes endpoint
- Provides a solution for the current overlay behaviour and inability to make changes to taxes in open/bookable status
Fees endpoint
- Gives the ability to update fees individually without overlay
- Information organised as fees rather than policies
When will the new APIs be available?
We plan to release the new APIs throughout 2024. Please see the product roadmap for the Content API Modularisation project below.
Support and feedback
Please read the FAQ section for more detailed information about implementation and timelines.
If you have further questions, do one of the following:
- Submit your questions in this form
- Email connectivity@tripeden.com
- Contact your Connectivity Partner Business Manager
Content API Modularisation FAQs
We will update these FAQs as we receive more questions, so please check back.
Should I implement all APIs together or can I do it one by one?
Consider what works best for your business. You can wait and build all at once when the APIs are fully delivered or as soon as each is launched to take advantage of the benefits immediately. To help make it easier for you to decide, we’ll identify which specific APIs are necessary to achieve certain goals, such as making a property open/bookable. We’ll share more information on this soon, together with options for integration.
When will I have to stop using Content API endpoints?
We’re working on a timeline and will be able to confirm soon. We expect to maintain the endpoints until 2026 and will adjust if we’re delayed with the delivery of new APIs. We’ll deprecate and sunset everything together, rather than a gradual deprecation based on the delivery of each new API, as you may want to wait before implementing them. We recommend implementing the new APIs when they become available as they will deliver benefits as well as new products and features.
What if I don't want to migrate from the Content API?
Unfortunately this isn’t an option. Content API endpoints will eventually be permanently removed.
How will you help us with migration?
We’ll provide you with clear documentation and information on:
- Descriptions and purposes of each new API and endpoint.
- Mapping of old fields to new fields, in case you need to alter existing data tables to store or share information for your UI.
- Any field renaming or changes to the database.
- Changes to validations moved to another API and considerations for building the workflow.
- New product improvements and what they enable you to do.
I’m currently implementing the Content API. Should I stop implementation?
This depends on the needs of your business. We recommend that everyone continues implementing the APIs that are already modular, such as the Photo API, Contracting API, Licences API, Property Profile API and Key Collection API. You can check the Onboarding Solutions page for more information about which features are being deprecated and when.
If you choose to implement the current Content API, please note that we will continue supporting it until 2026.
How does this affect my Connectivity Partner Programme (CPP) status?
The Content API Modularisation won’t affect the 2023 CPP. We’re currently working on a transition plan that minimises impact for the 2024 CPP.
Are there more details about the other new APIs and endpoints?
These are still in development and we plan to release them later in 2024. We will update this page with more information closer to their official launch dates.
Will authentication stay the same?
Yes.
Do these APIs require certification?
No, the APIs will be self-certified.
What pathway is Tripeden.com planning to take in terms of connectivity specifications?
We’ll stop supporting a large HDCN endpoint when building the new APIs. Instead, we plan to build a set of smaller, modularised JSON APIs. We will, however, try to follow the existing Content API request structure where possible in order to simplify future migrations for Connectivity partners. We’ll share migration guides soon.