E-Commerce REST API
Complete REST API documentation for an e-commerce platform covering customers, products, categories, and orders. Demonstrates OAuth2 with granular scopes, webhook signature security, and ERD lineage tracking.
The E-Commerce API provides endpoints for managing customers, products, categories, and orders. This example demonstrates OAuth2 authentication with granular scopes, webhook signature security for callbacks, and full schema lineage to database entities.
Customer Endpoints
Manage customer accounts and retrieve customer information.
API
List Customers
API
Get Customer
Product Endpoints
Browse and manage the product catalogue.
API
List Products
API
Get Product
API
Create Product
Category Endpoints
Manage product categories and category hierarchies.
API
List Categories
Order Endpoints
Create and manage customer orders.
API
Create Order
API
Get Order
API
Add Order Item
Security Schemes
| Scheme | Type | Use Case |
|---|---|---|
| OAuth2 | Authorization Code / Client Credentials | User and service authentication with scopes |
| API Key | Header (X-API-Key) | Partner integrations |
| Webhook Signature | HMAC Header | Webhook callback verification |
OAuth2 Scopes
| Scope | Description |
|---|---|
| customers:read | Read customer profiles |
| customers:write | Create and update customers |
| products:read | Browse product catalogue |
| products:write | Manage product inventory |
| categories:read | View product categories |
| categories:write | Manage category hierarchy |
| orders:read | View order history |
| orders:write | Create and manage orders |
| admin | Full administrative access |