FAQ

Why is the API being updated?

The initial version of the Winston API was structured in a way that made it difficult to add new features. Additionally, the update to a new major version of the framework we use comes with breaking changes which required us to update the way the API code was structured.

We decided to take this opportunity to finally apply the updates to the way the API works we previously couldn't do because of backwards compatibility concerns.

What is the main difference between the legacy and the new API?

Internally we have completely restructured the code. However, the main difference between the legacy and the new API for our integrators is the way the authentication is handled.

Authentication is no longer handled via the query parameters. The new API requires that the API key is provided through the Authorization HTTP header as a bearer token. This is the same API key as you'd previously provide in the api_key query parameter (exception noted below). The app_name query parameter is no longer required.

The new API no longer supports API keys that had a corresponding app_name value of 'selforder'. The corresponding integration also has been marked as legacy in our backoffice. The new API works with the new miscellaneous integration that requires you to sign up as an integrator before you can authenticate to our API.
If you are currently not using the 'selforder' app name, you don't have to do anything. The other integrations will still work with your existing API key.

Please read our migration guide for the full list of changes.

How long will the legacy API be supported?

We try to keep the legacy routes available and working for as long as possible. However, we will begin to monitor which legacy routes are still in use. Routes that have not been called in a certain time span be pruned.
We aim to eventually completely remove all legacy routes.

In the future the legacy API routes will be served by our new route handler code. We try to keep the behavior the same, nevertheless it is possible we inadvertently break some assumption held by one of our integrators. If you notice a difference please contact us immediately. We will make sure to stop the roll-out to apply a fix.

Will the legacy API receive feature updates?

No, new features will only be added to version 2 of the API. This applies to both the addition of new routes and the addition of new features to existing routes.

How much time do I have to update my implementation?

We hope you can get to it as soon as possible, however we realize that it is not feasible to ask everybody to update immediately.

We try to keep the legacy routes available and working for as long as possible.
However, since the legacy routes do not receive feature updates, we do require you to update in the case you require a new feature.

My legacy API integration suddenly broke?

Do you have a question that is not answered on this page, feel free to contact us.