Открытое API Bnovo PMS

Кому доступно
Получение доступа к API
Первое подключение
Доступные методы (бесплатная версия)
Пример использования метода
Ограничения

1. Кому доступно

Тип аккаунта: «Полный продукт» по новому и старому тарифу.
Роль: Владелец аккаунта.

2. Получение доступа к API

Перейдите в Bnovo Octopus → нажмите кнопку «Получить доступ к API» (в правом верхнем углу).
Заполните анкету с вопросами о целях использования API.
После отправки анкеты — станет доступна генерация ключа.
Сгенерируйте ключ и перейдите в Документацию.
Это нужно для работы с доступными методами забора данных из Bnovo PMS.

3. Первое подключение

Шаг 1.
Для запросов требуется JWT-токен (JSON Web Token).

JWT-токен (JSON Web Token) — это специальный формат токена, который позволяет безопасно передавать данные между клиентом и сервером.

После первого запроса по API PMS — появится возможность обновить ключ (например, если он был передан третьим лицам). Это сделано для того, чтобы «оборвать» все ранее использованные связи по паролю.

Шаг 2.
Чтобы получить JWT, авторизуйтесь по ID аккаунту и паролю, который сгенерирован в интерфейсе.
Укажите такие данные:

id — ID аккаунта
password — пароль

Шаг 3.
В документации можно выбрать шаг авторизации. Из него сразу перейти в клиент для отправки/получения запроса.

Шаг 4.
Импортируйте данные с запросами.

Шаг 5.
Указывается персональный id и password.

Шаг 6.
Нажмите кнопку Send, чтобы отправить запрос.

В ответ система пришлёт bearer access_token — он используется для методов Bnovo PMS.

4. Доступные методы (бесплатная версия)

В бесплатной версии API доступны два метода из PMS:

/bookings — список бронирований за выбранный период на шахматке. В ответе будут все статусы.
/bookings/{id} — данные по конкретному бронированию.

В документации есть примеры ответов для этих методов.
Чтобы воспользоваться этими методами, вставьте полученный bearer access_token.

Доступно сохранение токена bearer access_token в общем блоке «Bearer Token» — он будет автоматически подставляться при каждом запросе.

5. Пример использования метода

Допустим, нужно получить бронирования за период с 25.06 по 30.06 с помощью метода /bookings.

Укажите bearer access_token, который выдала система.
Заполните параметры:
- date_from — начальная дата (в нашем случае 25.06),
- date_to — конечная дата (30.06).

На скрине видно, как это выглядит в интерфейсе.

После этого нажмите «Send» — система вернёт список бронирований из PMS за указанный период.

6. Ограничения

Коды обработки:

200 — Успешно. Данные по бронированию получены.
401 — Ошибка авторизации. Токен не передан или недействителен.
404 — Метод API, либо какая-то сущность, необходимая для обработки запроса не найдена.
406 — Ошибка валидации. В теле ответа — список полей, которые не прошли проверку, с указанием типа ошибки и пояснением. Отправленные параметры тоже возвращаются.
500 — Запрос не может быть выполнен по причине внутренней ошибки в API.

Ограничения по количеству запросов:

Для запроса аутентификации /api/v1/auth и обновления API-ключа через интерфейс:

не более 10 запросов в минуту.

Для всех остальных методов:

до 180 запросов в минуту;
до 300 запросов за 5 минут;
до 1000 запросов в час;
до 10 000 запросов в сутки.

Если лимит превышен — система вернёт ошибку 429 Too Many Requests.

База знаний