API Access and Integration

Introduction

The RadHIL API allows you to programmatically access and manage your vacation rental data, pricing, and bookings. This guide will help you get started with integrating RadHIL into your own applications.

Authentication

To use the RadHIL API, you'll need to authenticate your requests using an API key. Here's how to obtain and use your API key:

  1. Log in to your RadHIL dashboard
  2. Navigate to Account Settings > API Access
  3. Click "Generate New API Key"
  4. Copy your API key and keep it secure

Include your API key in the header of each request:

Authorization: Bearer YOUR_API_KEY

API Endpoints

The RadHIL API provides the following main endpoints:

  • /properties - Manage your properties
  • /bookings - Handle bookings and reservations
  • /pricing - Access and update pricing information
  • /guests - Manage guest information
  • /analytics - Retrieve performance analytics

For detailed information on each endpoint and its methods, please refer to our full API documentation.

Rate Limits

To ensure fair usage and optimal performance, the RadHIL API has the following rate limits:

  • 100 requests per minute per API key
  • 1000 requests per hour per API key

If you exceed these limits, you'll receive a 429 Too Many Requests response. The response will include a Retry-After header indicating when you can resume making requests.

Error Handling

The API uses standard HTTP response codes to indicate success or failure of requests. Here are some common codes:

  • 200 OK - The request was successful
  • 201 Created - A new resource was successfully created
  • 400 Bad Request - The request was invalid or cannot be served
  • 401 Unauthorized - Authentication failed or user doesn't have permissions
  • 404 Not Found - The requested resource could not be found
  • 429 Too Many Requests - Rate limit exceeded
  • 500 Internal Server Error - Something went wrong on our end

Error responses will include a JSON body with more details about the error.

SDKs and Libraries

To make integration easier, we provide official SDKs for popular programming languages:

Webhooks

RadHIL supports webhooks for real-time notifications about events in your account. To set up webhooks:

  1. Go to Account Settings > Webhooks in your RadHIL dashboard
  2. Click "Add Webhook"
  3. Enter the URL where you want to receive webhook events
  4. Select the events you want to subscribe to
  5. Click "Save"

We'll send a POST request to your specified URL whenever a subscribed event occurs.

Best Practices

  • Store your API key securely and never expose it in client-side code
  • Implement proper error handling in your integration
  • Use our SDKs when available to simplify integration
  • Cache API responses when appropriate to reduce the number of API calls
  • Use webhooks for real-time updates instead of polling the API

Changelog

Stay up to date with API changes and improvements:

  • v2.1.0 (2023-06-15): Added support for multi-currency pricing
  • v2.0.0 (2023-03-01): Major version update with breaking changes. See migration guide.
  • v1.5.0 (2022-11-10): Introduced webhooks for real-time notifications

For a full list of changes, please visit our API Changelog page.