Versioning

The Forbix API is versioned, in order to minimize the impact of changes on the clients consuming it. Each breaking change will lead to a new version, and each API version is accessible through the following URL format:

https://api.forbix.ir/openapi/{{api-version}}

e.g: https://api.forbix.ir/openapi/v1 to use the first version of the API.

We will keep old versions operating for at least six months, and, if you are registered with Forbix, we will notify you by email in advance.

Within a given version, Forbix may introduce non-breaking changes to its API at any point. We recommend writing your code in a way that is robust to those changes. Those include:

• Adding new endpoints,
• Adding new fields to response payloads at any depth,
• Adding optional fields to request payloads,
• Adding new possible values among a list of enumerated constants,
• Reordering fields or unordered lists,
• Changing the format or length of identifiers on which no explicit format is documented.