Get everything you need about our API libraries and start with your integration with Capillary applications.

To integrate Capillary products into your app or website, follow these steps.

  1. Get your API keys to authenticate your integrations or API requests.
  2. Understand the sequence of APIs that needs to be consumed based on the events.
  3. Know your cluster to interact with the cluster allocated to your region.
  4. Make a test API call to ensure everything is up and working as expected.

Get your API Keys

Capillary authenticates your integration requests with API keys that are provided based on the network topologies. There are two types of topologies considered for integration. 

  1. Point-to-Point Integration - Integrating Capillary directly from the POS machine.

It is a basic form of integration for the retail environment and requires unique keys for each source to authenticate APIs. Based on the source list (could be the list of store and terminal) provided by the org, Capillary account POCs will share the keys. 

In point-to-point integration, a store terminal shall be considered as a single source and a unique key will be provided to consume APIs. For example, if you have 50 stores and 200 terminals, you will receive 200 keys that are unique for each terminal.

  1. ESB Integration - Integrating Capillary through a Middleware tool.

Know your cluster

Capillary has shared servers in different regions. If your org runs in different countries,  you can decide the server when setting up the org in Capillary.

Once a dedicated cluster is assigned to your org, you need to use the appropriate API endpoint to configure your app or website.

The following are the endpoints of different regions supported.


If you need to know your org cluster, contact your Capillary PoC.

Make a test API request

To ensure your integration is working as desired, make a test call.