Skip to content

Latest commit

 

History

History
51 lines (28 loc) · 2.92 KB

README.md

File metadata and controls

51 lines (28 loc) · 2.92 KB
Raw

Alert Integration Demo

Code examples for 3rd party developers integrating to the BiQ Alert system

Functionality

  • Maintaining a shadow data base of the customer at BiQ
  • Retieving updates to the customers from BiQ
  • Retieving notifications about the customers from BiQ

Introduction

A demo Visual Studio Solution for integration with BiQ CustomerShadow and AlertChanges API

It is a minimal solution for 2-way integration, only the most obvious fields are used.

Getting Started

  1. Get a API-key, tenantId and shadowSourceId from your contact person at BiQ. Write them into the 'ConfigValues.cs' file in the commen AlertIntegrationDemo project.

  2. Create a dummy customer system as a stand in for your production custumer management system. This is done by starting CustomerSystemInitializer; this createase a SQLite database in a file - it has one table: Customers and it is populatede with 5 test customers. (The file location can be changed using the App.config)

  3. Start ShadowWriter. This will send all (5) customers to CustomerShadow at BiQ, and it will keep posting updates to CustomerShadow when the customers in the dummy customer system are modified. Keep this running.

  4. Start ChangeReader. This will read proposed changes to the test customers from BiQ's ApprovedChanges. Keep this running.

  5. Start NotificationReader. This will read notifications about the test customers from BiQ. Keep this running.

Developing your own integration

You need to implement 3 parts:

  • A Shadow Maintainer.

This proccess should post all new customers to BiQ's customerShadow and put all modified customers to BiQ's customerShadow. The proccess should also delete customers from BiQ's customerShadow when a customer are deleted from the master system. And be able to post all customers to BiQ's customerShadow at integration start or at integration restart.

The documentation for the customerShadow API can be found her customerShadow API

In this demo most of the Shadow Maintainer funtionality is in the file /ShadowWriter/Program.cs

  • A Change Reader.

This process should retrieve approved changes from BiQ and update the customer system accordingly. The proccess shold keep track of which changes has been processed by storing a bookmark or a timestamp.

The documentation for the approvedChanges API can be found her approvedChanges API

In this demo most of the Change Reader funtionality is in the file /ChangeReader/Program.cs

  • A Notification Reader.

This process should retrieve notifications from BiQ and take appropriate action on relevant notification types. The proccess shold keep track of which notifications has been processed, by storing a bookmark or a timestamp.

In this demo most of the Notification Reader funtionality is in the file /NotiicationReader/Program.cs