Demos and Examples
Here you will find information about a range of BitBroker demo applications and connectors to help you understand what BitBroker is and how it can operate in complex data sharing scenarios.
Most importantly, it will help you get started building your own applications which use BitBroker data or your own data connectors to contribute data into the system.
Demo Applications
We have a number of example applications, which allow users to explore policy based access to data via the Consumer API.
Data Explorer
This application allows you to explore the entire Consumer API by directly trying out a number of interactive scenarios. It has a set of example data and polices already pre-installed and running.
You can explore using the Catalog API to try different, complex catalog queries. You can see how the results of these queries differ in the light of different policies - which you can switch between simply in the application.
Once you have executed a query and obtain entity instance records, you can use the Entity API to browse the whole list and inspect the details of individual entities.
Finally, for country
data, you can also see the Timeseries API in actions and integrated with a charting library.
Mapping Sample
This application allows you to explore the Consumer API via the medium of a mapping application. It has a set of example data and polices already pre-installed and running. The geographical attributes within the example data are used to populate a map view of the data records.
You can explore how the application outputs are changed in the light of different policies - which you can switch between simply in the application.
Demo Data Connectors
Here we provide a range of data connectors to help you understand what they are and how to build your own. Indeed, it is hoped that you can simply modify one of these data connectors to achieve your own data submission aims.
We currently have two types of example connector:
- File based - dataset loaded directly from a file
- RDBMS - data drawn from a relational database
All implementations upload data to the BitBroker catalog. They also fetch and return third-party data in their entity webhooks for the example country
dataset, and both support time series data for the country
dataset.
NodeJS » File Based
This example connector is implemented in NodeJS and uses a simple file as its source data store. Key characteristics of this connector are:
- Initial dataset loaded from a file over HTTP
- Supports for a range of file types: JSON, Microsoft Excel, CSV, etc
- Implements catalog updating via sessions
- Implements all webhook end-points
NodeJS » RDBMS
This example connector is implemented in NodeJS and uses a PostgreSQL database as its source data store. Key characteristics of this connector are:
- Initial dataset loaded via SQL calls on a relational database
- Implements catalog updating via sessions
- Implements all webhook end-points