Getting Started

Versioning

The API is versioned in the URL path. The current stable version is v1.

Versioned base URL
https://api.salonify.eu/api/v1

Stability policy

Within a major version we only make backwards-compatible changes. You can safely build against v1 and expect it to keep working.

Considered backwards-compatible

  • Adding new endpoints, resources, or optional request parameters.
  • Adding new fields to existing responses.
  • Adding new values to existing enums or new error code values.
  • Adding new webhook event types.
  • Adding new optional response headers.

Write tolerant clients

Ignore fields you do not recognize and do not fail on new enum or error code values. This keeps your integration working as the API grows.

Considered breaking

Breaking changes ship under a new major version (for example a future v2) and never inside v1:

  • Removing or renaming an endpoint, field, or parameter.
  • Changing the type or format of an existing field.
  • Making a previously optional parameter required.
  • Changing authentication or default behavior.

Deprecation policy

When a capability is scheduled for removal, we announce it in the Changelog and provide a migration path. A deprecated version remains available for a minimum of 12 months after a successor ships, so you have ample time to migrate.

Staying informed

Watch the Changelog for new features, new scopes, and new webhook events. Every meaningful change to the public API is recorded there in reverse-chronological order.