Overview
BroadNet API paths carry no version prefix: you call https://api.broadnet.me/sms/sendSms, not a /v1 path. Changes are tracked in two places: the version field of the OpenAPI spec, and the semantic version of the TypeScript SDK on npm.
Where versions live
The OpenAPI 3.1 spec at /developers/openapi.yaml records its version in info.version. The official SDK, @broadnet/cpaas-sdk, follows semantic versioning on npm: a new major version signals a breaking change to its generated method names or types.
Pin the SDK version in package.json and upgrade deliberately, after reading the release notes and running your tests.
Build tolerant clients
Most API changes add something: a new endpoint, a new optional field, a new status value. Write your integration so that additions are harmless.
Staying informed
- Watch the changelog for dated API changes.
- Diff the OpenAPI spec between downloads: a diff of the spec is a diff of the API.
- Pin @broadnet/cpaas-sdk to an exact version and read its release notes before upgrading.