Introduction

IndicaOnline Open API is a powerful and versatile tool designed to streamline your integration with third-party systems. Whether you're looking to automate simple data exchanges between platforms, sync inventory and sales data in real time, simplify compliance reporting or build a full-scale online ordering system for your website, our API provides the flexibility and reliability you need. Easily connect with e-commerce platforms, delivery services, customer management tools and much more.

With IndicaOnline Open API, you can forget about tedious manual data entry and enjoy seamless, real-time connectivity between your software solutions. Let’s jump right in!

Getting Started

Our documentation is split up into multiple sections for specific APIs, with each section containing a guide and an API Endpoint list. Guides provide a short description of particular APIs with examples of potential areas of application. API Endpoints are intended for your technical specialists who will integrate your third-party system with IndicaOnline. They provide descriptions for endpoint parameters, which allow you to see what a call to a particular endpoint might look like in various programming languages.

We use the following API Endpoints to facilitate third-party integrations:

Customer. Allows you to create, update, and synchronize all information required for customer profiles. For more information about Customer API uses, see Customer API Guide and Customer API Endpoints pages.
Delivery Address. Allows you to use existing addresses or add new ones for delivery orders. For more information about Delivery Address API use cases, see Delivery Address API Guide and Delivery Address API Endpoints pages.
Product. Allows you to create and update products, and download product-related data. For more information about Product API use cases, see Product API Guide page. For the list of Product API Endpoints and their use cases and parameter descriptions, see Product API Endpoints page.
Inventory. Allows you to manage your inventory. See Inventory API Guide and Inventory API Endpoints pages for more information.
Order. Allows you to get all of the information required to create an order, as well as create and cancel orders. For more information about Order API use cases, see Order API Guide page. For the list of Order API Endpoints and their use cases and parameter descriptions, see Order API Endpoints page.
Office. Allows you to see and update information about all company offices. For more information about Office API use cases, see Office API Guide page. For the list of Office API Endpoints and their use cases and parameter descriptions, see Office API Endpoints page.
Location. Allows you to identify the location of your office on a third party. See Location API Guide and Location API Endpoints pages for more information.
Staff. Allows you to receive data on employees involved in orders. For more information about Staff API use cases, see Staff API Guide and Staff API Endpoints pages for more information.
File. Allows you to exchange and allocate files and documents, see File API Guide and File API Endpoints pages for more information.

What is REST API

API is short for "Application Programming Interface". An API is a set of rules that lets programs talk to each other, exposing data and functionality across the Internet in a consistent format.

REST stands for "Representational State Transfer". This is an architectural pattern that describes how distributed systems can expose a consistent interface. When people use the term "REST API", they are generally referring to an API accessed using the HTTP protocol at a predefined set of URLs.

These URLs represent various resources — any information or content accessed at that location, which can be returned as JSON, HTML, audio files, or images. Often resources have one or more methods that can be performed on them over HTTP, like GET, POST, PUT, and DELETE. The action represented by the first and last of these is clear, but POST and PUT have specific meanings. How they are defined is confusing, but the general rule is to use POST to create resources, and PUT to update resources.