Skip to navigation

🎭 Experience Booking Service - Overview

Welcome to the Experience Booking API! 🎉

This comprehensive booking management system provides everything you need to handle experience bookings efficiently and reliably.

🚀 Core Capabilities

Multi-Provider Booking System

  • 🔗 Headout Integration - Direct integration with Headout’s experience network
  • ⚡ Instant Confirmations - Real-time booking confirmations
  • 📊 Comprehensive Coverage - Access to multiple experience providers

Real-Time Features

  • ⚡ Instant Availability - Real-time experience availability checking
  • ✅ Live Confirmations - Immediate booking confirmations when possible
  • 📱 Webhook Support - Real-time updates via webhooks
  • 🔔 Auto Notifications - Automated customer and experience provider notifications

Business Intelligence

  • 📊 Advanced Analytics - Comprehensive booking statistics and trends
  • 💰 Revenue Tracking - Estimated revenue impact and financial insights
  • 📈 Performance Metrics - Provider success rates and response times
  • 📋 Export Tools - Data export in CSV, XLSX, and JSON formats

🎯 API Endpoints Overview

📝 Booking Operations (/bookings)

  • Create new bookings with Headout integration
  • Retrieve, update, and cancel existing bookings
  • Bulk operations for experience management
  • User and experience booking history

📅 Availability Checking (/availability)

  • Real-time experience availability queries
  • Bulk availability checking for multiple dates
  • Capacity and timing information

🔌 Provider Management (/providers)

  • Headout integration health monitoring
  • Performance metrics and analytics

🔧 Management & Analytics (/management)

  • Comprehensive booking analytics
  • Data export and reporting tools
  • Experience configuration management
  • Operational insights and trends

🛡️ Enterprise Features

  • High Availability: Built-in redundancy and failover
  • Scalability: Handles thousands of concurrent bookings
  • Security: OAuth 2.0, rate limiting, and data encryption
  • Monitoring: Comprehensive logging and health checks
  • Integration: RESTful API with webhook support

🔗 Quick Start

  1. Check Service Health: GET /health
  2. Browse Documentation: Visit /swagger for interactive API docs
  3. Check Availability: GET /availability/{experienceId}?date=2024-02-15&partySize=4
  4. Make a Booking: POST /bookings with booking details

🆘 Support & Documentation

  • 📚 API Documentation: Available at /swagger
  • 🔍 Health Monitoring: Check /health for system status
  • 📞 Provider Status: Monitor at /providers/health
  • 📊 Analytics: Access insights via /management/{experienceId}/analytics

Authentication

AuthorizationBearer

JWT token from @etera-ai/auth package (auth.etera.dev) - Format: Bearer <token>

Response

Service information retrieved successfully
messagestring
versionstring
statusenum
Allowed values:
featureslist of strings
List of available service features
endpointsobject
Available API endpoint categories
timestampdatetime
Current server timestamp

Errors

503
Service Unavailable Error