n8n-nodes-hotelplanet/README.md

n8n node for HotelPlanet booking operations - AI Agent compatible

# n8n-nodes-hotelplanet

This is an n8n community node. It lets you use HotelPlanet API in your n8n workflows.

[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation tool.

[Installation](#installation)  
[Operations](#operations)  
[Credentials](#credentials)  
[Resources](#resources)  

## Installation

Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.

## Operations

### HotelPlanet

- **Get Hotels by Location**: Search for hotels by country and/or city with optional filters
- **Search Hotels**: Search hotels by query string
- **Get Hotel Details**: Get detailed information about a specific hotel
- **Check Availability**: Check hotel availability for specific dates and guests
- **Book Hotel**: Book a hotel room with guest information
- **Get Booking Details**: Get details of a specific booking
- **Cancel Booking**: Cancel an existing booking
- **Get User Bookings**: Get all bookings for a user by email

## Credentials

### HotelPlanet API

To use this node, you need to configure the HotelPlanet API credentials:

1. **Base URL**: The base URL of your HotelPlanet API server (default: http://localhost:3000)
2. **API Key**: Optional API key for authentication (if required)

## Resources

* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
* [HotelPlanet API Documentation](https://docs.hotelplanet.com)

## Version history

### 1.0.0

- Initial release
- Support for all hotel booking operations
- Integration with HotelPlanet API

## Usage Examples

### Example 1: Search for Hotels in New York

1. Add the HotelPlanet node to your workflow
2. Configure credentials with your API base URL
3. Select "Get Hotels by Location" operation
4. Set Country to "USA" and City to "New York"
5. Execute the workflow

### Example 2: Book a Hotel Room

1. Add the HotelPlanet node to your workflow
2. Configure credentials with your API base URL
3. Select "Book Hotel" operation
4. Fill in all required fields:
   - Hotel ID
   - Room IDs (comma-separated)
   - Check-in and Check-out dates
   - Guest information
5. Execute the workflow

### Example 3: Check Hotel Availability

1. Add the HotelPlanet node to your workflow
2. Configure credentials with your API base URL
3. Select "Check Availability" operation
4. Fill in:
   - Hotel ID
   - Check-in and Check-out dates
   - Number of guests and rooms
5. Execute the workflow

## Development

To build the node:

```bash
npm run build
```

To watch for changes:

```bash
npm run dev
```

## License

[MIT](LICENSE)