5.1. API Availability and versioning¶
This means that each API endpoint includes a version of the interface in the URL. Changes between versions are always breaking changes and upgrading to a new version of the API requires changes in the code.
CargoX guarantees that the APIs under the same version are constant. No breaking changes to the available APIs will happen. However, the following are still permitted and your code must be able to handle the transitions gracefully:
Input object (e.g. JSON) that you
PUTonto the platform might get new (non-mandatory) fields;
Output objects (e.g. JSON) that you
GETor receive as a result of an action might get new fields;
New methods may appear in the API.
Error messages might get more defined - e.g. instead of returning a generic
500error, the system might decide to return
403, or a custom code (e.g.