API Lifecycle Policy (Beta phase)

During current Beta & Controlled Availability (CA) phase, the main objective is to explore, propose and validate APIs which can bring the best value to the ecosystem. Although we target to publish stable APIs so that partners part of the program are not disrupted in their implementation, we may introduce changes that will have to be taken into account. Those changes will be identified and mentionned in release notes.

Breaking Changes

In very rare cases, we might introduce breaking changes in the API in this early stage of the program so that API can reach a mature state as soon as possible. This could be the case when the breaking change has in fact very limited impacts in practice, for example :

• Adding an enum value in a response but that only concerns a limited set of data and/or very specific scenarios that do not disrupt completely the previous implementation.
• Changing some behavior/logic that do not break the API contract per se but may still need attention from Partner side to ensure the implementation still meets their target.

New API Version / deprecation of APIs

If some complementary scenarios are identifed and requires significant and breaking changes in the existing API after initial release of the API, a new version or replacement of the API will be introduced. The deprecated API will still be fully functionnal for a minimum of 90days, Partners are then invited to switch to the new API as soon as possible.

Documentation / description update

Whenever we identify the need to complete or update the API documentation (without change in the API contract itself) we will do so to reach the most accurate and precise documentation. Significant changes that may requires attention will be mentionned in release notes.