Inforegister developers

Stream API

For developing real-time economy services

Inforegister Stream API provides access to streaming linked data, which is used to fuel decision-making solutions for Lead-to-Cash business processes. Examples of corresponding use cases include real-time lead scoring, lead nurturing and credit scoring, not to mention advanced analytics for real-time business insights, which will be incorporated into Inforegister.ee soon.

There are two kind of stream sources available - snapshot and changeset sources. While snapshot sources stream messages containing linked data of the state of a subject as it was capured at the time we retrieved the data, changeset sources encode differences with relation to previous snapshots. For instance, when a new company is established, the snapshot contains data about the company at the registration time, including its status "Registered", and the changeset includes data insertion instructions encoded according to Changeset (http://vocab.org/changeset) vocabulary. Now, if next time, when the company data is updated, only company status is changed (e.g. to "Deleted"), then the snapshot message contains data about the company at the deletion time, while changeset contains instructions to update the status change with relation to recent data.

Typically you could be interested in changeset messages if you have synchronized your database via Inforegister.ee Graph API and are interested only in updates. The benefit of using changeset messages is also that you do not need to implement comprehensive methods for detecting differences between data snapshots. Snapshot messages on the other hand are a practical approach when you do not care about recording data changes and simply overwrite old data, when an update becomes available.

Data in both types of stream sources is encoded following the linked data principles (see https://www.w3.org/standards/semanticweb/data for further details). There is a variety of types of data available via Stream API, which is served via corresponding changeset and snapshot sources. The structure and examples of messages of specific sources is found at API reference page.