Documentation

Overview

Welcome to the Rustic Manor API documentation. Our API provides programmatic access to estate management, reservation systems, and guest services integration.

Getting Started

To begin using the API, you'll need to obtain API credentials from your account dashboard. Once you have your client ID and secret, you can authenticate and start making requests.

Rate Limits

• Standard tier: 100 requests per minute
• Professional tier: 500 requests per minute
• Enterprise tier: Unlimited (subject to fair use)

API Reference

All API requests should include the following headers:

Content-Type: application/json
Authorization: Bearer {your_access_token}
X-API-Version: 2024-01

Request Format

Requests must be made over HTTPS. All POST and PUT request bodies should be valid JSON with the appropriate Content-Type header.

Authentication

We use OAuth 2.0 for authentication. The API supports the following grant types:

• Client Credentials - For server-to-server communication
• Authorization Code - For user-facing applications
• Refresh Token - For obtaining new access tokens

Token Response

{
  "access_token": "eyJhbGciOiJSUzI1NiIs...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "refresh_token": "dGhpcyBpcyBhIHJlZnJlc2g..."
}

Endpoints

Reservations

GET /reservations - List all reservations
POST /reservations - Create a new reservation
GET /reservations/{id} - Get reservation details
PUT /reservations/{id} - Update a reservation
DELETE /reservations/{id} - Cancel a reservation

Rooms

GET /rooms - List available rooms
GET /rooms/{id} - Get room details
GET /rooms/availability - Check availability

Events

GET /events - List booked events
POST /events - Create event booking
GET /events/venues - List available venues

Webhooks

Webhooks allow you to receive real-time notifications when events occur in our system.

Supported Events

• reservation.created - New reservation made
• reservation.updated - Reservation modified
• reservation.cancelled - Reservation cancelled
• payment.received - Payment processed
• checkin.completed - Guest checked in

Webhook Payload

{
  "event": "reservation.created",
  "timestamp": "2026-04-07T10:30:00Z",
  "data": {
    "id": "res_abc123",
    "guest_name": "Jane Smith",
    "check_in": "2026-04-15",
    "check_out": "2026-04-18"
  }
}

Error Codes

Our API uses standard HTTP status codes. Error responses include a JSON body with details:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid check-in date",
    "details": {
      "field": "check_in",
      "reason": "Date must be in the future"
    }
  }
}

Common Error Codes

• 400 - Bad Request
• 401 - Unauthorized
• 403 - Forbidden
• 404 - Not Found
• 429 - Rate Limit Exceeded
• 500 - Internal Server Error

SDK & Libraries

Official SDKs are available for popular programming languages:

• Python - pip install rusticmanor-api
• JavaScript/Node.js - npm install @rusticmanor/api
• PHP - composer require rusticmanor/api
• Ruby - gem install rusticmanor