🚀 REST API Documentation
Welcome to our comprehensive REST API documentation. This includes general API endpoints and the specialized BigCity Rewards API for reward redemption and voucher management.
🏃♂️ Quick Start
Base URL: https://api.example.com/v1
BigCity API: https://api.bigcity.in/v1
Authentication: Bearer token required for most endpoints
Content Type: application/json
Rate Limiting: 1000 requests per hour per API key
🎁 BigCity Rewards API
Comprehensive rewards and voucher management system for partner companies.
📚 General API Documentation
🎯 BigCity Rewards Quick Start
POST /v1/company/auth - Company authentication (Step 1)
POST /v1/customer/auth - Customer authentication (Step 2)
GET /v1/bigcity/rewards - List available rewards
POST /v1/bigcity/redeemptiononskus - Create redemption order
🎯 Core API Endpoints
POST /auth/login - Authenticate and receive access token
GET /users/profile - Get authenticated user's profile
GET /products - List products with filtering and pagination
POST /orders - Create a new order
🔧 Example Requests
BigCity Company Authentication
curl -X POST "https://api.bigcity.in/v1/company/auth" \
-H "Authorization: Required" \
-H "Content-Type: application/json" \
-d '{"secret": "your_company_secret"}'
General API Request
curl -X GET "https://api.example.com/v1/products?page=1&limit=10" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json"