> For the complete documentation index, see [llms.txt](https://developer.siteminder.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.siteminder.com/direct-booking-api/guides/integration-requirements.md).

# Integration Requirements

Understand what your integration must implement before connecting to production.

These requirements define the technical standards your integration must meet to work correctly with the Direct Booking API. Work through each section during your build — not after.

### Prerequisites

Before you can integrate, your account must have an active Direct Booking subscription with properties already configured (rates, room types, and availability set up). This API surfaces data from that existing setup — it does not provision or activate Direct Booking itself.

The API supports two integration types:&#x20;

* **Hotel groups —** available to groups on Multi-property with the SiteMinder Platform. Group-level API keys give access to all properties within the group.&#x20;
* **Individual properties —** available to independent properties on the SiteMinder Platform. Property-level API keys give access to a single property only.&#x20;

### Limitations

Groups and individual properties on the classic version of the SiteMinder Channel Manager will not be able to access the Direct Booking API.

### Authentication

Every request must include a valid API key passed in the `x-sm-api-key` header. Two types of API keys are supported:&#x20;

* **Group-level key —** generated in MP Extranet → Direct Booking → API tab. Gives access to all properties in the group.&#x20;
* **Property-level key —** generated in Platform → Direct Booking → Configuration → API Integration. Gives access to a single property only.&#x20;

{% code overflow="wrap" expandable="true" %}

```
Header:  x-sm-api-key: YOUR_API_KEY
```

{% endcode %}

The endpoints behave the same way regardless of key type, with one exception: `GET /properties` is only available to group-level keys.&#x20;

The key determines which properties are accessible. It must never be exposed in query parameters or client-side.&#x20;

### Intended Use

This API is intended to be used for server-to-server communications only. It is not intended to be used from a front-end web page as this will expose your secret key to the public and may also allow the API keys' rate limit to be exceeded and prevent API access.

### Scope

This API is read-only. It provides property, rate, and availability data to power your booking flow up to the quote stage — it does not create, retrieve, modify, or cancel reservations. Reservation creation happens through the standard Direct Booking booking flow.&#x20;

### Rate Limit

Each key is limited to 100 API calls per minute. Your integration must handle 429 responses with exponential backoff. Do not retry immediately, wait until the next minute.

### Pagination

Responses from list endpoints are paginated. Your integration must not assume all results are returned in a single response.

* Iterate through pages using the page parameter.
* Continue until page equals totalPages.
* Default page size is 10, adjust using perPage.

### Stay Length Limit

Availability queries via `/quotes` must not exceed 31 days per request. Split longer date ranges \
across multiple requests.

### Error Handling

Your integration must handle all error responses gracefully. Do not surface raw API error messages \
to guests.

### Data Freshness

The data is kept up to date as inventory is booked and changes are made to your configuration in Direct Booking. Avoid caching responses for extended periods to prevent stale availability being shown to guests.

{% hint style="success" icon="sparkles" %}

## Still have questions?

Use the <i class="fa-gitbook-assistant">:gitbook-assistant:</i> **Ask** button at the top of the page to chat with our AI assistant — it can help you navigate the guide, understand requirements, and troubleshoot issues.

If you need more support, visit [Integration Support](/integration-support/integration-support.md).
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.siteminder.com/direct-booking-api/guides/integration-requirements.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
