Integreren met ReflexBlue: Algemene aanpak
De ReflexBlue Externe API is bedoeld voor datasynchronisatie tussen ReflexBlue en andere back-end systemen. Deze API is niet ontworpen voor toepassingen met directe koppeling aan een front-end applicatie.
Het is technisch mogelijk om een front-end applicatie direct te koppelen aan deze API, maar dit scenario wordt niet ondersteund. De Externe API is uitsluitend bedoeld voor communicatie tussen back-end systemen.
De API is zo ontworpen dat je als extern systeem het rijversienummer (rowversion) kan gebruiken. Hiermee vraag je alleen de gegevens op van entiteiten die zijn gewijzigd sinds de laatste rijversie die je hebt ontvangen bij een vorig verzoek.
Door het gebruik van webhooks in combinatie met de rijversie, zorg je ervoor dat de data in je externe systeem altijd actueel blijft zodra er een wijziging plaatsvindt in ReflexBlue.
Gegevens synchroniseren tussen ReflexBlue en je back-end systeem
ReflexBlue kan automatisch webhook-verzoeken via HTTPS sturen naar je back-end zodra er gegevens worden bijgewerkt. Deze webhook-verzoeken bevatten precies genoeg informatie zodat je back-end weet welke gegevens zijn gewijzigd. Daarna kan je back-end de bijgewerkte gegevens ophalen via de ReflexBlue Externe API.
Het onderstaande diagram geeft een overzicht van het synchronisatieproces:
Je back-end systeem slaat de opgehaalde gegevens op in een eigen database. Zo kan je front-end applicatie altijd de meest actuele data tonen aan de eindgebruiker.
Als je back-end systeem geen webhooks kan ontvangen, kan je de rowversion gebruiken die in elke entiteit van ReflexBlue wordt bijgehouden. Hiermee kan je periodiek alle bijgewerkte gegevens ophalen.