API upgrades
Keep track of changes and upgrades to the Molink API
Your API version controls the API and webhook behavior you see (for example, what properties you see in responses, what parameters you’re permitted to send in requests, and so on).
When a breaking change is introduced to the Molink API, a new version is released and available in the path (e.g. "/v3"). To avoid breaking your code, we don’t change your version until you’re ready to upgrade.
Backwards-compatible changes
Molink considers the following changes to be backwards-compatible:
- Adding new API resources.
- Adding new optional request parameters to existing API methods.
- Adding new properties to existing API responses.
- Changing the order of properties in existing API responses.
- Changing the length or format of opaque strings, such as object IDs, error messages, and other human-readable strings.
- Make sure that your integration can handle Molink-generated object IDs, which can contain up to 255 characters.
- For example, if you’re using MySQL, store the IDs in a VARCHAR(255) COLLATE utf8_bin column (the COLLATE configuration provides case-sensitivity during lookups).
- Adding new event types.
- Make sure that your webhook listener gracefully handles unfamiliar event types.
Upgrade your API version
If you’re running an older version of the API, upgrade to the latest version to take advantage of new functionality or to streamline responses so the API is faster for you.
Upgrading your API version affects:
- The API calls you make: the parameters you can send and the structure of objects returned.
- The structure of objects sent to your webhook endpoints. If an endpoint has an explicit version set, it will remain unaffected.
Stay informed
We send information on new additions and changes to Molink’s API and language libraries in the Molink Developer Digest. Be sure to subscribe ("get updates" button at the top right and corner) to stay informed.
Updated 22 days ago