mirror of
https://github.com/marcogll/AnchorOS.git
synced 2026-03-15 11:24:26 +00:00
feat: implement customer registration flow and business hours system
Major changes: - Add customer registration with email/phone lookup (app/booking/registro) - Add customers API endpoint (app/api/customers/route) - Implement business hours for locations (mon-fri 10-7, sat 10-6, sun closed) - Fix availability function type casting issues - Add business hours utilities (lib/utils/business-hours.ts) - Update Location type to include business_hours JSONB - Add mock payment component for testing - Remove Supabase auth from booking flow - Fix /cita redirect path in booking flow Database migrations: - Add category column to services table - Add business_hours JSONB column to locations table - Fix availability functions with proper type casting - Update get_detailed_availability to use business_hours Features: - Customer lookup by email or phone - Auto-redirect to registration if customer not found - Pre-fill customer data if exists - Business hours per day of week - Location-specific opening/closing times
This commit is contained in:
Marco Gallegos
180
docs/API.md
Normal file
180
docs/API.md
Normal file
@@ -0,0 +1,180 @@
|
||||
# AnchorOS API Documentation
|
||||
|
||||
## Overview
|
||||
AnchorOS is a comprehensive salon management system built with Next.js, Supabase, and Stripe integration.
|
||||
|
||||
## Authentication
|
||||
- **Client Authentication**: Magic link via Supabase Auth
|
||||
- **Staff/Admin Authentication**: Supabase Auth with role-based access
|
||||
- **Kiosk Authentication**: API key based
|
||||
|
||||
## API Endpoints
|
||||
|
||||
### Public APIs
|
||||
|
||||
#### Services
|
||||
- `GET /api/services` - List all available services
|
||||
- `POST /api/services` - Create new service (Admin only)
|
||||
|
||||
#### Locations
|
||||
- `GET /api/locations` - List all salon locations
|
||||
|
||||
#### Availability
|
||||
- `GET /api/availability/time-slots` - Get available time slots for booking
|
||||
- `POST /api/availability/staff-unavailable` - Mark staff unavailable (Staff auth required)
|
||||
|
||||
#### Customers
|
||||
- `GET /api/customers` - Search customer by email or phone
|
||||
- `POST /api/customers` - Register new customer
|
||||
|
||||
#### Bookings (Public)
|
||||
- `POST /api/bookings` - Create new booking (supports customer_id or customer info)
|
||||
- `GET /api/bookings/[id]` - Get booking details
|
||||
- `PUT /api/bookings/[id]` - Update booking
|
||||
|
||||
### Staff/Admin APIs (Aperture)
|
||||
|
||||
#### Dashboard
|
||||
- `GET /api/aperture/dashboard` - Dashboard data
|
||||
- `GET /api/aperture/stats` - Statistics
|
||||
|
||||
#### Staff Management
|
||||
- `GET /api/aperture/staff` - List staff members
|
||||
- `POST /api/aperture/staff` - Create/Update staff
|
||||
|
||||
#### Resources
|
||||
- `GET /api/aperture/resources` - List resources
|
||||
- `POST /api/aperture/resources` - Manage resources
|
||||
|
||||
#### Reports
|
||||
- `GET /api/aperture/reports/sales` - Sales reports
|
||||
- `GET /api/aperture/reports/payments` - Payment reports
|
||||
- `GET /api/aperture/reports/payroll` - Payroll reports
|
||||
|
||||
#### Permissions
|
||||
- `GET /api/aperture/permissions` - Get role permissions
|
||||
- `POST /api/aperture/permissions` - Update permissions
|
||||
|
||||
### Kiosk APIs
|
||||
- `POST /api/kiosk/authenticate` - Authenticate kiosk
|
||||
- `GET /api/kiosk/resources/available` - Get available resources for kiosk
|
||||
- `POST /api/kiosk/bookings` - Create walk-in booking
|
||||
- `PUT /api/kiosk/bookings/[shortId]/confirm` - Confirm booking
|
||||
|
||||
### Payment APIs
|
||||
- `POST /api/create-payment-intent` - Create Stripe payment intent
|
||||
|
||||
### Admin APIs
|
||||
- `GET /api/admin/locations` - List locations (Admin key required)
|
||||
- `POST /api/admin/users` - Create staff/user
|
||||
- `POST /api/admin/kiosks` - Create kiosk
|
||||
|
||||
## Data Models
|
||||
|
||||
### User Roles
|
||||
- `customer` - End customers
|
||||
- `staff` - Salon staff
|
||||
- `artist` - Service providers
|
||||
- `manager` - Location managers
|
||||
- `admin` - System administrators
|
||||
- `kiosk` - Kiosk devices
|
||||
|
||||
### Key Tables
|
||||
- `locations` - Salon locations with business hours (JSONB)
|
||||
- `staff` - Staff members
|
||||
- `services` - Available services with category
|
||||
- `resources` - Physical resources (stations)
|
||||
- `customers` - Customer profiles
|
||||
- `bookings` - Service bookings
|
||||
- `kiosks` - Kiosk devices
|
||||
- `audit_logs` - System audit trail
|
||||
|
||||
### Business Hours Structure
|
||||
Locations table includes `business_hours` JSONB column with format:
|
||||
```json
|
||||
{
|
||||
"monday": {"open": "10:00", "close": "19:00", "is_closed": false},
|
||||
"tuesday": {"open": "10:00", "close": "19:00", "is_closed": false},
|
||||
"wednesday": {"open": "10:00", "close": "19:00", "is_closed": false},
|
||||
"thursday": {"open": "10:00", "close": "19:00", "is_closed": false},
|
||||
"friday": {"open": "10:00", "close": "19:00", "is_closed": false},
|
||||
"saturday": {"open": "10:00", "close": "18:00", "is_closed": false},
|
||||
"sunday": {"is_closed": true}
|
||||
}
|
||||
```
|
||||
|
||||
Default business hours (updated via migration):
|
||||
- Monday-Friday: 10:00 AM - 7:00 PM
|
||||
- Saturday: 10:00 AM - 6:00 PM
|
||||
- Sunday: Closed
|
||||
|
||||
## Environment Variables
|
||||
|
||||
### Required
|
||||
- `NEXT_PUBLIC_SUPABASE_URL`
|
||||
- `NEXT_PUBLIC_SUPABASE_ANON_KEY`
|
||||
- `SUPABASE_SERVICE_ROLE_KEY`
|
||||
- `NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY`
|
||||
- `STRIPE_SECRET_KEY`
|
||||
|
||||
### Optional
|
||||
- `ADMIN_ENROLLMENT_KEY` - For staff enrollment
|
||||
- `GOOGLE_SERVICE_ACCOUNT_KEY` - For Calendar sync
|
||||
|
||||
## Deployment
|
||||
|
||||
### Prerequisites
|
||||
- Node.js 18+
|
||||
- Supabase account
|
||||
- Stripe account
|
||||
- Google Cloud (for Calendar)
|
||||
|
||||
### Setup Steps
|
||||
1. Clone repository
|
||||
2. Install dependencies: `npm install`
|
||||
3. Configure environment variables
|
||||
4. Run database migrations: `npm run db:migrate`
|
||||
5. Seed data: `npm run db:seed`
|
||||
6. Build: `npm run build`
|
||||
7. Start: `npm start`
|
||||
|
||||
## Features
|
||||
|
||||
### Core Functionality
|
||||
- Multi-location salon management
|
||||
- Real-time availability system with business hours
|
||||
- Customer registration and lookup by email/phone
|
||||
- Location-specific opening/closing times
|
||||
- Automated payment processing (currently mock)
|
||||
- Staff scheduling and payroll
|
||||
- Customer relationship management
|
||||
- Kiosk system for walk-ins
|
||||
|
||||
### Booking Flow
|
||||
1. Customer selects service and location
|
||||
2. Customer chooses date and time slot
|
||||
3. Customer searches by email or phone:
|
||||
- If found: Pre-fill data and proceed
|
||||
- If not found: Redirect to registration
|
||||
4. Customer completes registration if needed
|
||||
5. Customer confirms personal details
|
||||
6. Customer pays deposit (mock currently)
|
||||
7. Booking confirmed with email confirmation
|
||||
|
||||
### Advanced Features
|
||||
- Role-based access control
|
||||
- Audit logging
|
||||
- Automated no-show handling
|
||||
- Commission-based payroll
|
||||
- Sales analytics and reporting
|
||||
- Permission management
|
||||
|
||||
### Security
|
||||
- Row Level Security (RLS) in Supabase
|
||||
- API key authentication for kiosks
|
||||
- Magic link authentication for customers
|
||||
- Encrypted payment processing
|
||||
|
||||
## Support
|
||||
|
||||
For API issues or feature requests, please check the TASKS.md for current priorities or create an issue in the repository.
|
||||
Reference in New Issue
Block a user