SELF-GUIDED BA PRACTICE Packages available · Access after confirmed paymentSee packages ↗

Business analysis glossary

API Versioning

What it is

API versioning is how an API provider manages changes so existing clients keep working, for example by putting a version number in the URL or a header. Breaking changes, such as removing a field or changing its meaning, go into a new version while the old one is supported for an agreed period.

Why it matters

Partners and apps rely on an API's behaviour. Changing it without versioning can break them overnight. Analysts must recognise when a requirement is a breaking change, plan the new version and the retirement date of the old one, and include communication to API consumers in the plan.

Example

The business wants to split the customer name field into first and last name. The analyst flags this as a breaking change for three partner apps. The team adds the new fields in version two, keeps version one working for six months and emails partners with the migration date.

CHECK BEFORE CONTINUING

Keep your work safe