Certification

Sigfox Certifications

Sigfox Certification Handbook

Helpful

Callbacks & APIAPI

API versioning

Sigfox manages its API system with versioning and follow the specification of the Semantic Versioning 2.0.0.

The API version controls the API behaviour (e.g., what properties you see in responses, what parameters are permitted to send in requests, etc.).

A version can be accessed by the API endpoint through a suffix in the endpoint URL. This suffix has the following format: "vX", where X is the major version number: for example, api.sigfox.com/v2/devices.

All requests must include the version suffix in the endpoint URL. The major version always includes the lastest minor and patch version.

To avoid a break in your system, only backward-compatible changes are included in the minor and patch versions.

The backwards-incompatible changes are integrated in the next major version of the API (vX+1). The current API version is stable until its full deprecation.

Here are the changes we consider as backwards-compatible and backwards-incompatible for our Sigfox API:

Backwards-compatible changes

• Adding a new API interface

• Adding a new HTTP binding to an interface

• Adding an optional field to the request message

• Adding a field to the response message

• Adding a value to an enum in the request message

• Changing Error message information in response message


Backwards-incompatible changes

• Adding a value to an enum in response message

• Removing or renaming an interface, a field or an enum value

• Changing an HTTP binding

• Changing the type of a field

• Changing visible behavior of existing requests

• Adding a mandatory field to the request message


Stay informed News and changes are published on Sigfox Portal Home page. Be sure to stay informed by subscribing on your user profile to release emails.


Can't find what you're looking for ?

Have questions? Our worldwide Community of expert fans can answer them.
Have answers? Join the Community and help!

sigfoxask

Ask the community >