API Versioning

Build integrations that remain maintainable as APIs evolve.

API versioning helps developers identify changes to an API's behavior, request formats, and response contracts.

Senmo's individual infrastructure products may use different versioning strategies.

API versions

An API version may be represented in a URL path, request header, or another documented mechanism.

For example, some APIs use versioned paths:

/v1/resources
/v2/resources

These paths are illustrative and do not identify actual Senmo endpoints.

Always consult the relevant API reference to determine which version is supported.

Types of changes

API changes may include:

Additive changes

Examples include new endpoints, optional parameters, or additional response fields.

Applications should avoid depending on undocumented assumptions about response structures.

Behavioral changes

Changes to validation rules, default values, or operation behavior may affect integrations even when endpoint paths remain unchanged.

Breaking changes

Changes that invalidate previously supported requests or remove required functionality may require application updates.

Integration compatibility

To reduce compatibility issues:

  • Use documented API versions.
  • Validate required response fields.
  • Avoid depending on undocumented behavior.
  • Test integrations when upgrading versions.
  • Review published changelogs.
  • Keep API integration logic maintainable and isolated from unrelated application code.

Deprecations

When an API operation is deprecated, developers should review the announced replacement and migration guidance.

Deprecation timelines and continued support are product-specific and should not be assumed.

Changelog

Visit Resources → Changelog for published platform and API changes.

The product-specific API reference remains the authoritative source for supported operations and version requirements.


Did this page help you?