Backward compatibility policy

While we are frequently adding features to our platform and APIs, we ensure that we follow a backward-compatible approach during our development process. What this means is that:

• New response fields are backward compatible: API updates that involve introducing new fields to the response schema will initially be released as optional parameters. You can safely ignore these new optional fields and gradually integrate them into your codebase. However, your code must be flexible enough to accept these new updates gracefully (i.e., not fail or generate an error when encountering new fields in the response).

Note: Your codebase should be designed to allow new or unknown fields and enums in the API response.

• Strategy for breaking changes: Occasionally, we may need to introduce breaking changes that will impact your integration. For such updates, we have a release strategy in place that gives enough time to add the changes to your codebase.
  
  

• Deprecated fields are highlighted: Our upgrades may sometimes deprecate selected fields within an API endpoint. These fields will be labeled as Deprecated in our developer portal documentation and would appear as shown in the following screenshot.

Best Practices

Spotnana's platform and APIs are constantly evolving and adding features to provide a great travel booking experience for our partners and clients. Keeping that in mind, here are some best practices we recommend when you are integrating with our APIs:

• Review our changelogs regularly: Use the following changelogs to keep track of the latest updates we release to our APIs:
  • API changelog (for all API updates)
  • Release timeline (for updates that require you to modify your code)
    
    
• Review our API Documentation: Our developer portal documentation is continuously updated to reflect any new fields, enum values or deprecated fields. Regularly review our documentation to keep track of the latest changes to our APIs.
  
  
• Expect new or unknown fields: While the new fields we release to APIs are always non-breaking changes, your parsing code should be designed to handle any new or unknown fields in our API response.
  
  
• Include our API changes in your development lifecycle: We recommend that you regularly review and accommodate any changes to our APIs as part of your normal development lifecycle. This will ensure that you get the maximum functionality from of our APIs.