Introduction to the Data API · Customer Documentation Portal

Overview

The Data API allows customers to:

Retrieve data from collection endpoints
Import data into the Kalibrate Pricing system using import endpoints

Data Organisation

Data in the API is grouped together into similar entities (e.g. Prices) and stored in collections. Each collection can store multiple Variants of an entity (e.g. Own Prices, Competitor Prices). More information on the organisation of data can be found here.

Collection Endpoints

Collection endpoints allow users to retrieve data from Kalibrate Pricing by executing queries against the documents contained within a collection using the API Query Language.

Documents matching the specified query will then be provided to the calling user or service as JavaScript Object Notation (JSON) documents which contain the attribtues of each document

Import Endpoints

Import endpoints allow users or systems to submit "batches" of simplfied entities (such as Prices or Volumes) to an endpoint. Kalibrate will then process these simplified entities and create the underlying data entities which are then stored in the Collection Endpoints

Authentication

To call the API endpoints, a user or system must first authenticate. Authentication to the data API uses the Open Auth OAuth2 protocol. As the endpoints are generally intdended to be used for other systems for integration purposes, we require the use of the OAuth2 client credentials flow. More details on this can be found in Authentication