Documentation Powered by ReDoc

Maps Booking Partners API (1.0)

Download OpenAPI specification:Download

Authentication

RequestJWT

https://jwt.io/introduction
header: {"alg": "HS256","typ": "JWT"}
payload: Обязательные поля указаны в описании каждого эндпоинта. Необходимо проверять соответствие полей в payload и данных в самом запросе. В payload могут добавляться дополнительные поля, они не должны влиять на проверку.

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Фид организаций

Список всех организаций, подключенных к партнеру, у которых доступна онлайн-запись.

JWT payload: {}
Timeout: 60s

query Parameters
cursor
string

Курсор для пагинации (идентификатор последнего элемента из предыдущего запроса)

count
integer [ 1 .. 500 ]
Default: 100

Количество организаций для получения (по умолчанию 100, максимум 500)

Responses

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "pagination": {
    }
}

Список услуг, доступных для онлайн-записи

JWT payload: {"companyId": "{companyId}"}
Timeout: 5s

path Parameters
companyId
required
string

Идентификатор организации

query Parameters
resourceId
string

Фильтрация по ресурсу (мастеру)

Responses

Response samples

Content type
application/json
{
  • "services": [
    ]
}

Список ресурсов, доступных для онлайн-записи

JWT payload: {"companyId": "{companyId}"}
Timeout: 5s

path Parameters
companyId
required
string

Идентификатор организации

query Parameters
serviceIds[]
Array of strings
Examples:
  • serviceIds[]=1 -
  • serviceIds[]=1&serviceIds[]=2 -

Фильтрация по списку услуг, выбранных пользователем

Responses

Response samples

Content type
application/json
{
  • "resources": []
}

Отзывы на ресурс

JWT payload: {"companyId": "{companyId}"}
Timeout: 5s
Отзывы запрашиваются, только если у ресурса reviewsCount > 0

path Parameters
companyId
required
string

Идентификатор организации

resourceId
required
string

Идентификатор ресурса

Responses

Response samples

Content type
application/json
{}

Список доступных для записи дат

JWT payload: {"companyId": "{companyId}"}

path Parameters
companyId
required
string

Идентификатор организации

query Parameters
serviceIds[]
required
Array of strings
Examples:
  • serviceIds[]=1 -
  • serviceIds[]=1&serviceIds[]=2 -

Фильтрация по списку услуг, выбранных пользователем

resourceId
string

Фильтрация по ресурсу (мастеру)

from
required
string (Date)
Example:

Дата в формате ISO 8601 (YYYY-MM-DD)

to
required
string (Date)
Example:

Дата в формате ISO 8601 (YYYY-MM-DD)

Responses

Response samples

Content type
application/json
{
  • "availableDates": [
    ]
}

Список доступных для записи слотов

JWT payload: {"companyId": "{companyId}"}
Timeout: 5s

path Parameters
companyId
required
string

Идентификатор организации

query Parameters
serviceIds[]
required
Array of strings
Examples:
  • serviceIds[]=1 -
  • serviceIds[]=1&serviceIds[]=2 -

Фильтрация по списку услуг, выбранных пользователем

resourceId
string

Фильтрация по ресурсу (мастеру)

date
required
string (Date)
Example:

Дата в формате ISO 8601 (YYYY-MM-DD)

Responses

Response samples

Content type
application/json
{
  • "availableTimeSlots": [
    ]
}

Получение специальных условий бронирования

JWT payload: {"companyId": "{companyId}"}
Timeout: 5s

path Parameters
companyId
required
string

Идентификатор организации

query Parameters
serviceIds[]
required
Array of strings
Examples:
  • serviceIds[]=1 -
  • serviceIds[]=1&serviceIds[]=2 -

Фильтрация по списку услуг, выбранных пользователем

resourceId
string

Фильтрация по ресурсу (мастеру)

datetime
required
string (Datetime)
Example:

Timestamp в формате ISO 8601, обязательно должен быть указан часовой пояс

Responses

Response samples

Content type
application/json
{
  • "specialConditions": [
    ]
}

Создать запись

JWT payload: {"companyId": "{companyId}", "userPhone": "{userPhone}"}
Timeout: 5s

Request Body schema: application/json
required
object (BookingInput)

Responses

Request samples

Content type
application/json
{
  • "booking": {
    }
}

Response samples

Content type
application/json
{
  • "booking": {
    }
}

Получить информацию о записи

JWT payload: {"bookingId": "{bookingId}"}
Timeout: 5s

path Parameters
bookingId
required
string

Responses

Response samples

Content type
application/json
{
  • "booking": {
    }
}

Обновить запись (перенести на другое время, обновить комментарий)

JWT payload: {"bookingId": "{bookingId}"}
Timeout: 5s

При изменениях в записи (изменение статуса/перенос/отмена), которые совершаются внутри системы партнера (не инициированы описанным здесь запросом), необходимо отправить PUT-запрос https://partner.maps.yandex.net/booking/v1/partners/{partnerId}/{bookingId} чтобы синхронизировать состояние записи с личным кабинетом пользователя в Картах

path Parameters
bookingId
required
string
Request Body schema: application/json
companyId
required
string
comment
string
datetime
string (Datetime)

Timestamp в формате ISO 8601, обязательно должен быть указан часовой пояс

Responses

Request samples

Content type
application/json
{
  • "companyId": "string",
  • "comment": "string",
  • "datetime": "2023-10-15T08:48:00.000Z"
}

Response samples

Content type
application/json
{
  • "booking": {
    }
}

Отменить/удалить запись

JWT payload: {"bookingId": "{bookingId}"}
Timeout: 5s

path Parameters
bookingId
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "CANCEL_FORBIDDEN"
}

Создать предварительную бронь на слот

Эндпоинт не обязателен для реализации, если функциональность предварительного бронирования не предусмотрена.
JWT payload: {"companyId": "{companyId}"}
Timeout: 5s

Request Body schema: application/json
companyId
required
string
required
object (Appointment)

Responses

Request samples

Content type
application/json
{
  • "companyId": "string",
  • "appointment": {
    }
}

Response samples

Content type
application/json
{
  • "prebooking": {
    }
}

Отменить/удалить предварительную бронь на слот

JWT payload: {"prebookingId": "{prebookingId}"}
Timeout: 5s

path Parameters
prebookingId
required
string

Responses