Your Integration Needs Versions Too, Not Only the API
You change how a "department" field is mapped and deploy it. The next morning, every customer on that integration sees their reports grouped differently. Nobody asked for it. Providers version their APIs. Your integration code, or the connectors you use, needs versions too.
Three numbers, three meanings
- Major (1.x.x): a breaking change, like a field renamed or removed.
- Minor (x.4.x): something new that does not break old use.
- Patch (x.x.2): a bug fix.
This is semantic versioning. Once a version is released, it must not change. So "we run 1.4.2" means the same thing every day.
Pin production, test on staging
Pinning means production uses an exact version, like 1.4.2, not "whatever is newest". In npm, ~1.2.3 accepts new patch versions, ^1.2.3 accepts new minor and patch versions, and a plain 1.2.3 accepts only itself.
npx --yes semver -r "~1.2.3" 1.2.9 1.3.0 2.0.0When a new version comes out, point a staging setup at it, run the same requests on both, and compare. Move production’s pin only if the difference is what you expected. Allow automatic updates only where a surprise is fine, usually patch releases.