asked on February 6, 2022
hi:
I am not claire about API_VERSION.
this is a parameter than we can changer like we want at server or
It's must be same with client sides.
for example, at the client sides, I use flexmonster 2.9.16.
and at the server side, could i use your server api (2.8.5)( without any change ) ?
will there be a problem or not ?
⋅ February 7, 2022
Hello,
Thank you for your question.
Flexmonster uses the API_VERSION that your server sends in the /handshake response to ensure that the component and the server follow the same request and response structure.
When implementing your own custom data source API, our team recommends using the same version as Flexmonster's for the API_VERSION. Afterward, it is usually not necessary to keep the version on the server the same as Flexmonster's when updating Flexmonster to a newer version. This is because the protocol is not updated as frequently as Flexmonster. When the protocol is updated, it comes with a new release version of Flexmonster and is announced in our release notes. This is when you are welcome to update your server implementation, if necessary, and change the protocol version (API_VERSION) if you would like to incorporate the changes.
The minimum required server API version (API_VERSION) is 2.8.5. So, answering your question about using 2.8.5, if your server implements the 2.8.5 protocol version, it will work fine with the latest versions of Flexmonster.
Starting from API version 2.8.22, our team improved the custom data source API protocol, and slight changes were made to the request/response structure. This means that Flexmonster will use a slightly different request/response structure depending on whether:
2.8.22 (starting from 2.8.5).2.8.22 and later, for example, 2.9.16.
The corresponding differences are addressed in our documentation in the request/response structure description.
Please let us know if this helps.
Kind regards,
Vera