REST API

Overview

Venddor IO offers an integrated API for seamless store interaction.

The Venddor IO API:

• Is structured on REST principles.
• Employs Basic HTTP authentication, with admin email serving as login and an automatically generated API key as the password.
• Utilizes user group-determined privileges, which are specified directly within the objects.
• Harnesses HTTP 1.1 to implement REST functionalities.
• Supports 4 methods to view and modify objects: GET (retrieve object data), PUT (update object data), POST (create a new object), and DELETE (remove object).
• Operates primarily using JSON format for data exchange.

Activating API Access

API accessibility is toggled on a per-user basis.

To activate:

1. Log into the Venddor IO admin panel.
2. Navigate to Customers → Administrators.
3. Select the desired admin account.
4. Go to the API access tab and enable "Yes, allow this user to use the API".
5. Save changes. The generated API key and user email will serve as credentials for API access.

API URL Patterns

A standard API request involves sending an HTTP request to a specific URL. Venddor IO's default setup employs API 1.0, with URLs fashioned in a structured manner, such as:

• http://example.com/api/:object for referring to all objects of a specific type.
• http://example.com/api/:object/:id for targeting a singular object.

However, for the recommended API 2.0, the URL structure slightly differs, such as:

• http://example.com/api/2.0/:object to access all objects of a certain type.

Authentication

All requests necessitate authentication through the user's email and API key. This can be accomplished in several ways:

1. Via the --user parameter.
2. Inline within the URL.
3. Within the request header.

Data Operations

• GET: Retrieves specific object data.
• PUT: Updates existing object data.
• POST: Creates new objects.
• DELETE: Removes specified objects.

Using Tools like cURL & Postman

Both cURL (a command-line tool) and Postman (a Google Chrome extension) can be utilized to send HTTP requests and interact with the API effectively. Throughout this guide, examples are presented as cURL commands.

In conclusion, Venddor IO's API provides a robust platform for developers to engage deeply with their online store, ensuring a seamless and dynamic integration process. Whether you're looking to retrieve product details, update user profiles, or manage orders, the Venddor IO API covers it all.