Introduction

Synerise RESTful APIs are a quick and simple way to integrate your existing or future systems to interact with Synerise or benefit from functionalities available within your applications.

API Reference & Postman Collection

You can find our API References here: API Reference

To open Synerise’s collection in Postman, click here: Run in Postman

SSL

Synerise API requires connectivity over HTTPS (SSL) and supports the TLS 1.2 protocol (support for newer version to be added in near future).

Note: On older configurations, an update may be required, including the update of CA certificate repository.

API Versioning

Synerise is being built with CI/CD (Continuous Integration/Continuous Delivery) principles in mind and we often deploy changes multiple times a day.

We do not have fixed release cycles, but instead features are brought live for you as soon as they are ready.

Such an approach allows us to deliver features, changes, and bug fixes very fast and keeping track of them is possible thanks to our live changelog.

Thus, as part of our API Contract, we want to ensure that within an API Version:

  1. No fields will be deleted or changed in a non-backwards compatible way.
  2. We make changes that are additional, such as new fields, new methods, new error messages/codes, or mandatory parameters becoming optional (but, generally speaking, not causing compatibility issues).

Whenever we may need to roll out elements that are not backwards compatible, we will do that as a new API version for the given functional area, so an endpoint that was versions 1 is now also available as version 2, with the previous one still being operational.

Deprecation

Endpoints that already have newer versions send X-API-DEPRECATED in the response Headers, giving you time to switch to the new endpoint.

Deprecated API endpoints are also marked visually in the API reference pages.

😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.