🌟 Botble CMS REST API Connector

Transform your Botble CMS eCommerce platform into a powerful, secure, and production-ready REST API.

Botble CMS REST API Connector is a complete API solution that exposes your eCommerce platform through a structured, versioned, and secure REST API. It allows external systems, websites, dashboards, third-party applications, integrations, and custom frontends to communicate seamlessly with your Botble CMS installation.

The connector is designed around Laravel best practices, providing optimized endpoints for products, categories, customers, authentication, orders, wishlists, checkout, wallet balances, and other core eCommerce operations.

⚡ Core Value Propositions

🚀 Production-Ready REST API

Expose your Botble CMS eCommerce functionality through clean, consistent, and well-structured REST API endpoints.

🔐 Secure Authentication

Authentication is powered by Laravel Sanctum, providing secure API token management and protected access to customer-specific resources.

⚡ High Performance

API endpoints are optimized using:

• Laravel best practices

• Database indexing

• Eager loading

• Pagination

• Query optimization

• Response optimization

• Efficient relationship loading

🔄 API Versioning

All endpoints are organized under a versioned API structure:

/api/v1

This allows future API versions to be introduced without breaking existing integrations.

🌍 Integration Ready

The API can be consumed by:

• Web applications

• Desktop applications

• Mobile applications

• POS systems

• ERP systems

• CRM platforms

• Third-party services

• Custom dashboards

• Business intelligence systems

• External eCommerce interfaces

• Other backend services

🧩 Modular Architecture

The API is designed to work with the existing Botble CMS eCommerce infrastructure while providing a clean integration layer between Botble and external systems.

🛠️ Core API Features

Authentication

Complete customer authentication functionality including:

• Customer registration

• Email/password login

• Logout

• Token authentication

• Social authentication

• Current-user information

• Account deletion

Products

Access and manage product information through structured API endpoints.

Features include:

• Product listing

• Product details

• Product search

• Search suggestions

• Product filtering

• Product pagination

• Product categories

• Product pricing

• Product images

• Product attributes

• Product variations

• Product availability

Categories

Retrieve the complete product category structure.

Features include:

• Parent categories

• Child categories

• Nested categories

• Category details

• Category-based product filtering

Wishlist

Authenticated customers can manage their wishlist through the API.

Features include:

• Retrieve wishlist

• Add product to wishlist

• Remove product from wishlist

• Toggle wishlist status

Cart & Checkout

Provide API access to the complete purchasing workflow.

Features include:

• Cart management

• Add products to cart

• Update cart quantities

• Remove cart items

• Calculate totals

• Apply applicable pricing rules

• Checkout

• Order creation

Orders

Authenticated customers can retrieve their order information.

Features include:

• Order history

• Order details

• Order status

• Payment status

• Fulfillment status

• Order items

• Order totals

Customer Profile

Authenticated users can manage their customer information.

Features include:

• Profile information

• Customer details

• Account settings

• Authentication status

• Account deletion

Wallet

Provide access to customer wallet/store-credit information.

Features include:

• Current wallet balance

• Wallet transactions

• Store credit information

🔌 REST API Reference

All endpoints are available under:

/api/v1

🔓 Public Endpoints

These endpoints do not require authentication.

API Initialization

GET /api/v1/init

Returns API configuration, system information, supported features, and relevant platform settings.

Products

GET /api/v1/products

Retrieve a paginated list of products.

Example:

GET /api/v1/products?page=1&per_page=20

Supported parameters may include:

page per_page search category brand sort order min_price max_price

Product Details

GET /api/v1/products/{slug}

Retrieve detailed information about a specific product.

Example:

GET /api/v1/products/iphone-15-pro

Product Search Suggestions

GET /api/v1/products/search-suggest

Retrieve search suggestions based on a search keyword.

Example:

GET /api/v1/products/search-suggest?q=iphone

Categories

GET /api/v1/categories

Retrieve the product category hierarchy.

Login

POST /api/v1/login

Authenticate a customer.

Request:

{ "email": "customer@example.com", "password": "password" }

Response:

{ "success": true, "message": "Login successful", "data": { "token": "TOKEN", "token_type": "Bearer", "user": { "id": 1, "name": "John Doe", "email": "customer@example.com" } } }

Registration

POST /api/v1/register

Create a new customer account.

Request:

{ "name": "John Doe", "email": "customer@example.com", "password": "password", "password_confirmation": "password" }

Social Authentication

POST /api/v1/social-login

Authenticate or register a customer through a supported social authentication provider.

🔒 Authenticated Endpoints

Authenticated endpoints require:

Authorization: Bearer {TOKEN}

Current User

GET /api/v1/me

Retrieve the currently authenticated customer's profile.

Logout

POST /api/v1/logout

Revoke the current authentication token.

Account Deletion

DELETE /api/v1/account/delete

Permanently delete the authenticated customer account.

This endpoint supports privacy and account-management requirements.

❤️ Wishlist API

Get Wishlist

GET /api/v1/wishlist

Retrieve the authenticated customer's wishlist.

Add/Remove Wishlist Item

POST /api/v1/wishlist/toggle

Request:

{ "product_id": 123 }

🛒 Cart & Checkout API

Get Cart

GET /api/v1/cart

Retrieve the current customer's cart.

Add to Cart

POST /api/v1/cart/add

Request:

{ "product_id": 123, "quantity": 2 }

Update Cart

PUT /api/v1/cart/update

Request:

{ "product_id": 123, "quantity": 3 }

Remove Cart Item

DELETE /api/v1/cart/remove

Request:

{ "product_id": 123 }

Checkout

POST /api/v1/checkout

Create an order using the customer's current cart and checkout information.

📦 Orders API

Order History

GET /api/v1/orders

Retrieve the authenticated customer's orders.

Supports pagination:

GET /api/v1/orders?page=1&per_page=20

Order Details

GET /api/v1/orders/{id}

Retrieve detailed information about a specific order.

💰 Wallet API

Wallet Balance

GET /api/v1/wallet/balance

Retrieve the authenticated customer's wallet/store-credit balance.

Example response:

{ "success": true, "data": { "balance": 25000, "currency": "NGN" } }

📊 Standard API Response Structure

All API responses should follow a consistent structure.

Successful Response

{ "success": true, "message": "Request successful", "data": {} }

Error Response

{ "success": false, "message": "Validation failed", "errors": { "email": [ "The email field is required." ] } }

🔐 API Security

The API implements multiple security mechanisms including:

• Laravel Sanctum authentication

• Bearer token authentication

• Request validation

• Authorization checks

• Rate limiting

• CSRF protection where applicable

• Input sanitization

• SQL injection protection through Laravel's database layer

• Secure password hashing

• Protected customer resources

• Permission-based access control

Sensitive endpoints require authentication and appropriate authorization.

⚙️ API Configuration

API configuration can be managed through the Botble CMS administration environment.

Configuration options may include:

• API enable/disable

• API version

• Authentication settings

• Token configuration

• Rate limits

• Pagination limits

• Allowed origins

• API access controls

• Response settings

• Cache settings

🚀 Installation

1. Install the Connector

Upload the API connector package to:

platform/plugins/

Example:

platform/plugins/rest-api/

2. Activate the Plugin

From the Botble CMS administration panel:

Admin Panel → Plugins → REST API Connector → Activate

3. Configure the API

Navigate to:

Admin Panel → Settings → REST API

Configure the required API settings.

📚 API Documentation

The API can be documented using an industry-standard specification such as OpenAPI 3.0.

Example:

/api/v1/docs

The documentation can provide:

• Endpoint descriptions

• Authentication requirements

• Request parameters

• Request bodies

• Response structures

• Error responses

• HTTP status codes

• Example requests

• Example responses

🧱 API Architecture

The connector follows a structured Laravel architecture:

Client │ ▼ REST API │ ▼ Routes │ ▼ Controllers │ ▼ Requests / Validation │ ▼ Services │ ▼ Repositories / Models │ ▼ Botble CMS Database

This architecture keeps the API layer separated from the presentation layer while allowing it to leverage the existing Botble CMS business logic.

🌐 Integration Architecture

The API acts as an integration layer between Botble CMS and external systems.

┌─────────────────────┐ │ Botble CMS │ │ eCommerce │ └──────────┬──────────┘ │ ▼ ┌─────────────────────┐ │ REST API Layer │ │ /api/v1 │ └──────────┬──────────┘ │ ┌────────────────────┼────────────────────┐ │ │ │ ▼ ▼ ▼ Web Platforms ERP / CRM Systems External Services │ │ │ ▼ ▼ ▼ Websites Dashboards Integrations

🎯 What This API Provides

The REST API provides external systems with a standardized way to interact with the Botble CMS eCommerce platform.

It provides access to:

• Authentication

• Customers

• Products

• Categories

• Brands

• Wishlist

• Cart

• Checkout

• Orders

• Payments

• Wallets

• Customer profiles

• Product search

• Product filtering

• System configuration

The API is designed to be frontend-independent, meaning the API does not depend on any particular user interface, framework, device, operating system, or client application.

Any compatible client capable of making HTTP requests can consume the API.