Venddor API - Overview

API Overview

The Venddor API provides a comprehensive set of tools for integrating with the Venddor e-commerce platform. Our API follows RESTful principles and is designed for seamless integration with your existing systems.

Key API Characteristics:

RESTful implementation using HTTP 1.1
Basic HTTP authentication with admin email as login and API key as password
Accepts and returns data in JSON format
User group-defined privileges with assignments defined in objects

Available Methods

The following HTTP methods are available for interacting with resources:

Method	Description
GET	Retrieve object data from the system
PUT	Update existing object data
POST	Create a new object in the system
DELETE	Remove an object from the system

Tip: When working with the API, always ensure you're using the appropriate HTTP method for your desired operation. Using incorrect methods may result in unexpected behavior.

Authentication

All API calls require authentication. Use your admin email as the username and your API key as the password with Basic HTTP Authentication.

Authorization: Basic {base64_encoded_credentials}

Note: To generate the base64 encoded credentials, concatenate your admin email and API key with a colon (admin@example.com:your_api_key) and encode the result in base64.

Data Format

The Venddor API accepts and returns data in JSON format. All data fields are provided as strings or arrays/objects, regardless of their logical data type.

{
  "product_id": "42",
  "product_code": "PRD-001",
  "product_name": "Premium T-shirt",
  "price": "29.99",
  "in_stock": "Y",
  "options": [
    {
      "option_id": "3",
      "option_name": "Size"
    },
    {
      "option_id": "4",
      "option_name": "Color"
    }
  ]
}