Skip to main content

Backend API

You can use API for integrating the Inspector Cloud retail analytics system with third-party services. The API allows one to load in the Inspector Cloud photos of shelves with goods and receive analytical reports.

The API is implemented in the REST architecture over the HTTPS protocol. The content of requests and responses is sent in JSON format, unless explicitly indicated otherwise.

Interaction with the portal backend is possible using two different APIs — Recognition и Data API.

Recognition API

This integration method is used if a third-party system makes the visits itself. For example, you have a third-party mobile application with your backend. Users work in it, visit stores and take photos.

Photos for recognition and processing are transmitted to the Inspector Cloud portal. The portal processes the information and returns it to the employee in the application so that he can quickly influence the situation in the store before the end of the visit.

How to start

  1. Get the token and domain name from the Inspector Cloud manager.
  2. Upload images to the portal and get their IDs.
  3. Create a visit and get the ID.
  4. Run photo recognition.

To update information about manufacturers, brands, categories and SKUs of products, use API methods.

Data API

Users perform tasks of visits and take photos of products (in IC Camera or third-party application), and the portal collects and processes data. Using API methods, you can get analytical information and the results of visits to a third-party system. You can use this data to build analytics, upload it to the cloud, or combine it with other data sources on your side.

How to start

  1. Get the token and domain name from the Inspector Cloud manager.
  2. Upload a list of new visits. You can do this on a timer, for example once an hour.
  3. Get detailed information for each visit.
  4. Confirm receipt of each visit so that they do not appear in the next request for new visits.

To update information about manufacturers, brands, categories and SKUs of products, use API methods.

If you have any questions or problems, contact technical support.