Skip to main content

Documentation structure

The documentation is divided into 3 main sections, corresponding to the Bot Ban Hang system architecture.

Apps​

Describes the business API of applications in the system (Business Logic). Each app is an independent service handling a specific group of business operations.

  • Schema / Interface — Input and output data structures for each API
  • Endpoints — API list and usage guide
  • Business Rules — Processing flows and business rules

Example: api_oms manages orders, products, inventory, and shipping.

Services​

Describes integration services — modules that connect with third parties or provide shared services for multiple apps.

  • Payment — Multi-platform payment gateway (MoMo, ZaloPay, VNPay, Stripe...)
  • Delivery — Shipping carrier integration (GHN, GHTK, J&T...)

Each service has its own API for Apps in the system to call.

Component UI​

A shared UI component library for frontend applications in the Bot Ban Hang ecosystem.

  • Component View — Display components (tables, forms, cards...)
  • Core Component — Foundation components (layout, navigation, theme...)

Contents