# API Documentation

Everything you need to connect external systems to Hostel Mate—create bookings, sync guests, fetch availability, and more.

## Quick Start

1. Generate an API key: [API Access](https://docs.hostelmate.co/finance-management/user-management/api-access)
2. Exchange the key for a bearer token: [Authentication](https://docs.hostelmate.co/api-documentation/authentication)
3. Call your first endpoint—for example [Bookings Create](https://docs.hostelmate.co/api-documentation/bookings-create)

## Core Guides

* Authentication: issue tokens and handle rate limits — [read more](https://docs.hostelmate.co/api-documentation/authentication)
* Booking Engine API: surface availability on your website — [read more](https://docs.hostelmate.co/api-documentation/booking-engine)
* Booking operations: [Bookings List](https://docs.hostelmate.co/api-documentation/bookings-list), [Booking Detail](https://docs.hostelmate.co/api-documentation/bookings-get), [Bookings Create](https://docs.hostelmate.co/api-documentation/bookings-create), [Bookings Update](https://docs.hostelmate.co/api-documentation/bookings-update), [Booking Logs](https://docs.hostelmate.co/api-documentation/bookings-logs), and [Booking Delete](https://docs.hostelmate.co/api-documentation/bookings-delete)
* Payments endpoint: [Payments](https://docs.hostelmate.co/api-documentation/payments)
* Guests endpoints: [Guests GET](https://docs.hostelmate.co/api-documentation/guests-get) and [Guests Update](https://docs.hostelmate.co/api-documentation/guests-update)

## Best Practices

* Store API keys server-side only; rotate them after staff changes
* Use `Idempotency-Key` headers on write requests to prevent duplicates
* Respect the 120 req/min limit and add exponential backoff on 429 errors
* Log request IDs from responses to speed up support investigations

## Need Help?

Send request IDs, timestamps, and payload summaries to <contact@hostelmate.co> when opening a support ticket so we can assist quickly.