API Integrations
Adaptive Catalog operates as an API first company, so any functionality you see in the Adaptive Catalog application can be replicated using your own application. This means you could theoretically white label the entire experience for your users.
API Versioning
Adaptive Catalog utilizes API versioning with a {major}.{minor} versioning syntax. Once an API version has been pushed to production, we will no longer make any breaking changes to that version. Major version changes are used to denote breaking changes, while minor version updates are used for sizable changes that do not introduce any breaking changes. Each release of Adaptive Catalog generally includes multiple API updates, however most will not be a breaking change and will just be adding endpoints.
We recommend pinning your application to a specific API version using the x-api-version HTTP header. Once a new API version is released, we support previous versions for at least 6 months, and will generally have at least 2 previous major versions supported.
Environments
Adaptive Catalog provides 3 publicly accessible environments to all of our customers & integrators allowing them to use our standard production application, as well as see what is coming up with the latest release candidate or preview features. For private preview features, they must be enabled for an individual organization before they can be used on any of the APIs.
Production
This is the most stable and tested environment. We recommend most customers use this for any mission critical workloads as this environment has been rigorously tested by our QA team and our beta testers as ready for release. The API documentation can be found at the following URL:
https://api.adaptivecatalog.com/api-docs
Preview
This is our release candidate and has been validated by our QA team as stable. We strive to keep this environment as polished as our production environment. Except for specific extremely large feature releases, most releases will only be in the preview environment for 1-2 weeks before being deployed to production.
https://preview-api.adaptivecatalog.com/api-docs
Canary
This environment is used to test in development features. We do not recommend using this for production use, as it can often contain bugs or missing features. Generally you will be working with the Adaptive Catalog API team and be directed to use this for new work that you are partnering on while it is still in development.
API Versions
Adaptive Catalog will generally support 3 major versions of our API, and once a new major version is released, a the oldest major version will be sunset. (For example, when v4.0 was released, v1.0 and v1.1 were sunset). Once we know an API will be sunset, we will include that date below.
Version 4.0 - https://api.adaptivecatalog.com/swagger/v4/swagger.json
Version 3.0 - https://api.adaptivecatalog.com/swagger/v3/swagger.json
Version 2.0 - https://api.adaptivecatalog.com/swagger/v2/swagger.json
Sunset APIs
Version 1.0 - July 15th, 2024
Version 1.1 - July 15th, 2024