Skip to main content

​
Welcome to Test Project

Test Project is a comprehensive e-commerce backend API service built with the Falcon framework. It provides robust REST endpoints for managing catalogs, carts, checkouts, orders, and user accounts with enterprise-grade features including multi-database support, advanced caching, and seamless third-party integrations.

Quick Start

Get up and running with the API in minutes

Authentication

Learn how to authenticate your API requests

API Reference

Explore the complete API documentation

Architecture

Understand the system architecture

​
Key Features

Comprehensive REST API

Full-featured e-commerce endpoints for catalog, cart, checkout, orders, and user management

Multi-Database Support

MySQL for relational data, MongoDB for flexible schemas, and Redis for high-performance caching

Async Task Processing

Celery-based background task processing for order fulfillment, notifications, and data synchronization

GraphQL Support

Flexible GraphQL endpoint for efficient data querying alongside traditional REST APIs

Payment Integration

Built-in support for payment gateways and shipping providers with automated order processing

Advanced Caching

Beaker and Redis-powered caching layers for optimized performance and reduced database load

Social Authentication

JWT-based authentication with support for Google, Facebook, and Apple social login

Real-time Inventory

Live inventory tracking and order management with automated stock synchronization

​
Technology Stack

The API is built on a modern Python stack optimized for high-performance e-commerce operations:
  • Web Framework: Falcon 3.x - Fast, lightweight WSGI framework
  • Databases: MySQL (primary), MongoDB (catalog/cache), Redis (sessions/cache)
  • Task Queue: Celery with Redis broker for asynchronous processing
  • Caching: Beaker with Redis backend for multi-tier caching
  • Search: Elasticsearch for product search and filtering
  • Graph Database: Dgraph for relationship queries
  • API: REST + GraphQL endpoints
  • Authentication: JWT with social OAuth2 support

​
API Capabilities

  • User registration and login with OTP verification
  • Social login (Google, Facebook, Apple)
  • JWT token-based authentication
  • Profile management and address handling
  • Wishlist and order history
  • Product listings with pagination and filtering
  • Category and artist-based browsing
  • Product variants and pricing tiers
  • Image sitemaps and SEO optimization
  • Real-time inventory tracking
  • Cart operations (add, update, remove items)
  • Coupon and discount application
  • Gift voucher support
  • Shipping cost calculation
  • Address validation and delivery estimates
  • Order creation and payment processing
  • Order tracking and status updates
  • Cancellation and refund handling
  • Exchange and return processing
  • Automated notifications (SMS, email, WhatsApp)
  • Multiple payment method support
  • Coupon validation and application
  • Wallet and loyalty points
  • Gift vouchers
  • Cashback processing
  • GraphQL API for flexible queries
  • Product search with Elasticsearch
  • Shipping provider integration (Clickpost)
  • Payment gateway webhooks
  • Third-party analytics and marketing tools

​
Getting Started

1

Review Prerequisites

Ensure you have Python 3.10+, MySQL, MongoDB, and Redis installed and running
2

Set Up Your Environment

Clone the repository and configure your environment variables using the .env.example template
3

Install Dependencies

Install required Python packages and initialize the database schema
4

Start the API Server

Run the Falcon application with Gunicorn and start making API requests

Continue to Quick Start

Follow our step-by-step guide to get the API running locally

Build docs developers (and LLMs) love

Get started for freeTalk to us