10 Versioning

All v1 APIs are backwards compatible, and we maintain best efforts to maintain backwards compatibility of v0 APIs. In the event of a breaking change, this is noted on the following Customer Support Portal article: Oracle Hospitality Integration Platform Upcoming Major Changes. To be notified when the Upcoming Major Changes log is updated, press the Subscribe button on this page.

With REST APIs the expectation is that the server and client are loosely coupled. As mentioned in Anti-Patterns, it is recommended that you follow the "Tolerant Reader" pattern, using only the operations and resource definitions needed by your integration and ignore operations and resources that are not relevant to your integration.

When following this pattern, there is no need to regenerate the code when specifications change because backwards compatibility assures you that existing code will work. Further, any newly added optional fields or operations are irrelevant to the way the code works. This also keeps the code lean.

How do I know when new APIs are released?

The Oracle Hospitality Integration Platform Patch Release Notes list all new and deprecated APIs. To be notified when a new patch release note is issued, click the Subscribe button on this page.

What version of the OPERA Property APIs are available in OHIP?

The version number is the one in the API specifications themselves as displayed in the API search engine in the APIs tab of the developer portal and in the specifications themselves.

Is the OPERA Property APIs version the same as the OHIP developer portal version?

No. The OHIP developer portal version, which is visible by clicking the My Profile dropdown at the top right of the Developer Portal, relates only to the OHIP version, not the version of any APIs available via OHIP.

The environment I'm calling is on a different version of OPERA Cloud than the version in the specifications, is that a problem?

No. As mentioned above, v1 APIs are backwards compatible. Therefore, an operation available in OPERA Cloud 23.2 will work exactly the same way whether the version of specifications in OHIP is 23.2 or higher.

If the release notes include a new API operation added in a later release (for example, 24.1), then this will be available only in OPERA Cloud 24.1+ environments.