Integrating with ReflexBlue: General approach
The ReflexBlue External API is intended for data synchronization between ReflexBlue and other back-end systems. This API is not designed for applications that connect directly to a front-end application.
It is technically possible to connect a front-end application directly to this API, but this scenario is not supported. The External API is intended exclusively for communication between back-end systems.
The API is designed so that, as an external system, you can use the row version (rowversion). With this, you only request the data of entities that have changed since the last row version you received in a previous request.
By using webhooks in combination with the row version, you ensure that the data in your external system is always up to date as soon as a change occurs in ReflexBlue.
Synchronizing data between ReflexBlue and your back-end system
ReflexBlue can automatically send webhook requests via HTTPS to your back-end as soon as data is updated. These webhook requests contain just enough information so that your back-end knows which data has changed. After that, your back-end can retrieve the updated data via the ReflexBlue External API.
The diagram below provides an overview of the synchronization process:
Your back-end system stores the retrieved data in its own database. This way, your front-end application can always display the most up-to-date data to the end user.
If your back-end system cannot receive webhooks, you can use the row version that is maintained on each entity in ReflexBlue. This allows you to periodically retrieve all updated data.