Skip to main content

Getting Started with RatesSpot API

Welcome to RatesSpot - the most comprehensive headless booking engine available. Built for developers who demand flexibility and businesses that need enterprise-grade features.

What makes RatesSpot different?

431 endpoints across every business domain. Real-time monitoring. Auto-generated documentation. Enterprise features out-of-the-box. This isn't just another booking API - it's a complete platform.

Why Choose RatesSpot?​

🚀 Built for Scale​

  • Multi-location support with location-specific pricing
  • Team management with role-based permissions
  • Advanced analytics with revenue tracking
  • Real-time performance monitoring

💰 Payment Intelligence​

  • Stripe integration with webhook handling
  • Deposit payments and balance collection
  • Automated refunds with policy enforcement
  • Revenue sharing and merchant payouts

🎯 Developer Experience​

  • Auto-generated SDKs for popular languages
  • Interactive testing tools (Postman/Insomnia collections)
  • Comprehensive documentation that stays current
  • Live API monitoring and usage analytics

Quick Start (5 minutes)​

Step 1: Get Your API Key​

# Sign up and get your credentials
curl -X POST "https://api.ratesspot.com/api/auth/api-keys" \
  -H "Authorization: Bearer YOUR_CLERK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "My First API Key", "permissions": ["read", "write"]}'

Step 2: Create Your First Customer​

curl -X POST "https://api.ratesspot.com/api/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com", 
    "phone": "+1234567890"
  }'

Step 3: Make a Booking​

curl -X POST "https://api.ratesspot.com/api/bookings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "cust_xxxxx",
    "resourceId": "res_xxxxx", 
    "startTime": "2024-12-01T10:00:00Z",
    "endTime": "2024-12-01T11:00:00Z"
  }'

Architecture Overview​

graph TB
    A[Your Application] --> B[RatesSpot API]
    B --> C[Booking Engine]
    B --> D[Payment Processing]
    B --> E[Customer Management]
    B --> F[Analytics & Reporting]
    
    C --> G[Multi-Location Support]
    C --> H[Resource Management] 
    C --> I[Availability Engine]
    
    D --> J[Stripe Integration]
    D --> K[Automated Refunds]
    D --> L[Revenue Sharing]
    
    E --> M[Customer Profiles]
    E --> N[Loyalty Program]
    E --> O[Preferences & History]

Core Features Deep Dive​

📅 Booking Management​

// Complete booking lifecycle with advanced features
const booking = await ratesspot.bookings.create({
  customerId: 'cust_123',
  resourceId: 'res_456', 
  startTime: '2024-12-01T10:00:00Z',
  endTime: '2024-12-01T11:00:00Z',
  addOns: ['addon_massage', 'addon_refreshments'],
  discountCode: 'WELCOME10'
});

// Automatic waitlist management
await ratesspot.waitlist.promote(booking.id);

🏢 Multi-Location Enterprise​

// Location-specific pricing and management
const location = await ratesspot.locations.create({
  name: 'Downtown Branch',
  address: '123 Main St, City',
  pricing: {
    baseRate: 100,
    locationMultiplier: 1.2  // 20% premium
  }
});

// Team management with delegation
await ratesspot.team.addMember({
  locationId: location.id,
  role: 'MANAGER',
  permissions: ['bookings', 'customers', 'reports']
});

💰 Intelligent Payments​

// Deposit payments with automatic balance collection
const payment = await ratesspot.payments.createIntent({
  bookingId: 'book_123',
  type: 'DEPOSIT',
  percentage: 30,  // 30% deposit
  balanceDate: '2024-12-01'  // Collect balance on booking date
});

// Automated refunds based on cancellation policies
const refund = await ratesspot.refunds.process({
  bookingId: 'book_123', 
  reason: 'customer_cancellation',
  // Refund amount calculated automatically based on policy
});

What You Get Out-of-the-Box​

🛠️ Development Tools​

📊 Business Intelligence​

  • ✅ Revenue analytics with trend analysis
  • ✅ Customer insights and segmentation
  • ✅ Performance monitoring with health scores
  • ✅ Tax reporting and financial summaries

🔗 Integrations​

  • ✅ Stripe for payments
  • ✅ Google Calendar sync
  • ✅ Zapier for 6,000+ app connections
  • ✅ Webhook system for real-time updates

Success Stories​

"RatesSpot saved us 6 months of development time. The multi-location features and advanced analytics were exactly what we needed for our spa chain."
— Sarah Chen, CTO at Wellness Group

"The auto-generated documentation and testing tools make integration incredibly smooth. Our developers were productive from day one."
— Marcus Rodriguez, Lead Developer at BookSmart

Ready to Build?​

Choose Your Path:​

🚀 For Developers

Jump straight into the code with our comprehensive API reference and testing tools.

View API Reference →

🎯 For Businesses

See how RatesSpot can transform your booking operations with real examples.

Read Case Studies →

⚡ Quick Demo

Get up and running in minutes with our step-by-step tutorial.

Start Tutorial →

Need Help?​

Ready to scale your booking business?

RatesSpot handles the complexity so you can focus on growth. Get started today →