Applicable Environments

In all cases, the policy applies to the production integrator API (available on all tenants at https://tenant.alisqi.com/api).

For sandbox environments, a best-effort approach is applied.

For tenants in the Validate deployment model the release of new APIs will come in the validation cycle after release on the non-validate tenants.

Definitions

Integrator API

The integrator API is available on all tenants as documented at https://developer.alisqi.com. It is the supported interface for integration into an AlisQI tenant.

Breaking Changes

A change introduced by AlisQI that can cause existing client integrations to fail or behave incorrectly.

Examples of a breaking change include:

Removal of API endpoints
Removing or renaming fields on an existing API endpoint
Changing a field type or its behavior
Changes to the required properties in a request

Non-Breaking Changes

A change that does not influence existing client integrations.
Examples of a non-breaking change include:

Addition of optional fields in a request or new fields in a response.
New endpoints.
Internal changes to the endpoint that address bugs (that do not affect the API contract) or performance concerns
Note: A client that may strictly validate the API schema and could be affected, but is not considered part of the integration scope.

Deprecation

A deprecation is a scheduled change to the API that - on a predefined date - will be applied.

Change Management Policy

Breaking Changes

Notice Period

For breaking changes, we will provide at least 180 calendar days’ notice before the effective date of any Breaking Change in the production APIs.

The 180-day notice period starts from the date the change is formally announced through one or more of the communication channels.
During this notice period, the existing behavior will remain available.

Communication

For each breaking change, AlisQI will provide where viable:

A description of the expected change
The effective date of the change
Required changes for existing integrations, and where possible migration guidance
Headers, toggle flags, or additional API endpoints that can be provided to enable new behavior ahead of release

Exceptions

In rare circumstances, at its discretion AlisQI may introduce breaking changes with less than 180 days’ notice, including immediate changes with no notification.

This is limited to changes that address immediate security concerns or reliability of the platform, such as data integrity or performance. In such cases, we will:

Limit the changes to the smallest possible scope.
Provide notice and migration guidance as soon as reasonably possible.
Explain the needed change and reasoning for the shortened notice period.

Non-breaking changes

Notice Period

For a non-breaking change, a notice period does not apply.

Communication

Changes in this category will be communicated (where necessary) in product updates.

Deprecation Process

When the deprecation process is initiated, AlisQI will provide:

The affected API endpoint
The deprecation date (start of deprecation process)
The sunset date (end of deprecation process and change applied)

The sunset date is 180 calendar days after the deprecation date.

Excluding exceptional circumstances, the API change will only be applied after the sunset date. From the deprecation date, AlisQI will attempt to provide methods to activate new functionality ahead of the sunset date.

In some cases, the API may have its new functionality delivered ahead of the sunset date (such as newly required fields), but a sane default will be applied until the sunset date.

Responsibilities

AlisQI

Provide at least 180 calendar days’ notice for breaking changes in the API contract (excluding exceptions).
Where viable, provide guidance on migration steps for these changes.

Customer

Implement the integration API as per the provided documentation.
Observe communication from AlisQI regarding changes on the integration API.
Execute changes to an implementation in line with required changes to the integration API.
Promptly address security or reliability concerns in relation to the usage of the integration API.