Перейти к основному содержимому
API docs by Redocly

Integration API (v1)

Download OpenAPI specification:Download

IntegrationApi

Отмена предварительной записи

Request Body schema: application/json
apiKey
string or null

Ключ доступа к API.

appointmentId
string or null

Идентификатор записи, которую необходимо изменить.

Если хотим найти существующую запись среди всех записей заявителя отменить ее - получаем идентификатор из метода "Получение данных о заявителе, его активных записях и истории прошлых записей" (поле appointments.id).

или

Если только что создали запись и хотим сразу отменить её - получаем идентификатор из метода "Создание записи" (поле appointments.id).

Responses

Request samples

Content type
application/json
{
  • "appointmentId": "75ee8a60-7cf6-4ecc-b17e-bb53db3035b4",
  • "apiKey": "3dfdc1ed-ce72-46d1-89c9-376df0f83237"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "successMessage": "Успешно",
  • "failReasonMessage": "Бронирование уже было отменено ранее"
}

Создание предварительной записи

Request Body schema: application/json
apiKey
string or null

Ключ доступа к API.

customerId
string or null

Внутрисистемный идентификатор заявителя. Из метода "Создание или обновление данных о заявителе".

object (Person)
officeId
string or null

Идентификатор места, в котором оформляется запись. Получается из метода "Получение информации о всех доступных местах" (поле offices.id).

lineId
string or null

Идентификатор очереди, в рамках которой оформляется запись. Получается из метода "Получение информации о всех доступных местах" (поле lines.id внутри объекта offices).

serviceId
string or null

Идентификатор услуги, для которой создается запись. Получается из метода "Получение информации о всех доступных местах" (поле services.id внутри объекта lines).

units
integer <int32>

Количество единиц услуги, указанное пользователем при записи.

comment
string or null

Не актуальный параметр.

timeSlotId
integer <int64>

Идентификатор выбранного временного слота для записи. Получается из метода "Получение доступных временных интервалов для записи" (поле timeSlots.id)

deviceType
string (DeviceType)
Enum: "Browser" "Android" "iOS"

Responses

Request samples

Content type
application/json
{
  • "customerId": "e3c53333-2552-46ce-b2de-752c094b9cf6",
  • "affiliatedApplicant": {
    },
  • "officeId": "0fcab951-92e8-49a0-af78-f95c459f74bc",
  • "lineId": "33add1ef-2d42-4d67-b098-56d87a2f988f",
  • "serviceId": "da204cee-98ad-4a3e-872d-9f9b7c5d89e7",
  • "units": 10,
  • "comment": "Комментарий",
  • "timeSlotId": 123245346346,
  • "deviceType": "Browser",
  • "apiKey": "3dfdc1ed-ce72-46d1-89c9-376df0f83237"
}

Response samples

Content type
application/json
{
  • "appointment": {
    },
  • "success": true,
  • "successMessage": "Успешно",
  • "failReasonMessage": "Бронирование уже было отменено ранее"
}

Получение информации о предварительной записи

Request Body schema: application/json
apiKey
string or null

Ключ доступа к API.

appointmentId
string or null

Идентификатор записи.

Если хотим найти существующую запись среди всех записей заявителя - получаем идентификатор из метода "Получение данных о заявителе, его активных записях и истории прошлых записей" (поле appointments.id).

или

Если только что создали запись - получаем идентификатор из метода "Создание записи" (поле appointments.id).

loadDeleted
boolean

Нужно ли искать запись среди ранее удаленных. Данный функционал не работает.

Responses

Request samples

Content type
application/json
{
  • "appointmentId": "75ee8a60-7cf6-4ecc-b17e-bb53db3035b4",
  • "loadDeleted": true,
  • "apiKey": "3dfdc1ed-ce72-46d1-89c9-376df0f83237"
}

Response samples

Content type
application/json
{
  • "isDeleted": false,
  • "customer": {
    },
  • "appointment": {
    }
}

Изменение предварительной записи

Request Body schema: application/json
apiKey
string or null

Ключ доступа к API.

appointmentId
string or null

Идентификатор существующей записи. Передается, если необходимо изменить дату или время уже созданной записи.

Если редактируем существующую запись - получаем идентификатор из метода "Получение данных о заявителе, его активных записях и истории прошлых записей" (поле appointments.id).

или

Если создаем запись - получаем идентификатор из метода "Создание записи" (поле appointments.id).

officeId
string or null

Идентификатор офиса, который был выбран при изменении записи.

Получается из метода "Получение информации о всех доступных местах" (поле offices.id).

lineId
string or null

Идентификатор очереди, которая была выбрана при изменении записи.

Получается из метода "Получение информации о всех доступных местах" (поле lines.id внутри объекта offices).

serviceId
string or null

Идентификатор услуги, которая была выбрана при изменении записи.

Получается из метода "Получение информации о всех доступных местах" (поле services.id внутри объекта lines).

units
integer <int32>

Количество единиц услуги, указанное при изменении записи.

comment
string or null

Не актуальный параметр.

timeSlotId
integer <int64>

Идентификатор временного интервала, выбранного при изменении записи.

Получается из метода "Получение доступных временных интервалов для записи" (поле timeSlots.id).

deviceType
string (DeviceType)
Enum: "Browser" "Android" "iOS"

Responses

Request samples

Content type
application/json
{
  • "appointmentId": "75ee8a60-7cf6-4ecc-b17e-bb53db3035b4",
  • "officeId": "0fcab951-92e8-49a0-af78-f95c459f74bc",
  • "lineId": "33add1ef-2d42-4d67-b098-56d87a2f988f",
  • "serviceId": "da204cee-98ad-4a3e-872d-9f9b7c5d89e7",
  • "units": 10,
  • "comment": "Комментарий",
  • "timeSlotId": 123245346346,
  • "deviceType": "Browser",
  • "apiKey": "3dfdc1ed-ce72-46d1-89c9-376df0f83237"
}

Response samples

Content type
application/json
{
  • "appointment": {
    },
  • "success": true,
  • "successMessage": "Успешно",
  • "failReasonMessage": "Бронирование уже было отменено ранее"
}

Получение данных о заявителе, его активных предварительных записей и истории прошлых бронирований

Request Body schema: application/json
apiKey
string or null

Ключ доступа к API.

customerId
string or null

Внутрисистемный идентификатор заявителя. Из метода "Создание или обновление данных о заявителе".

historyDepthInMonths
integer <int32>

Глубина загрузки истории записей в месяцах. Например, если передано значение 6, то в ответе вернется история за последние полгода.

Responses

Request samples

Content type
application/json
{
  • "customerId": "75ee8a60-7cf6-4ecc-b17e-bb53db3035b4",
  • "historyDepthInMonths": 1,
  • "apiKey": "3dfdc1ed-ce72-46d1-89c9-376df0f83237"
}

Response samples

Content type
application/json
{
  • "customer": {
    },
  • "appointments": [
    ],
  • "history": [
    ]
}

Создание или обновление данных о заявителе

Request Body schema: application/json
apiKey
string or null

Ключ доступа к API.

customerId
string or null

Внутрисистемный идентификатор заявителя.

null если запись создается. Генерируется системой при создании нового заявителя через метод "Создание или обновление данных о заявителе".

externalId
string or null

Внешний идентификатор заявителя, который соответствует DeviceId пользователя.

Используется для поиска пользователя в системе, если customerId не был передан. Если пользователь не найден по externalId, создается новый пользователь.

Важно отметить, что DeviceId нигде не возвращается в ответах API, поэтому получить его извне не представляется возможным.

object (Person)

Responses

Request samples

Content type
application/json
{
  • "customerId": "e3c53333-2552-46ce-b2de-752c094b9cf6",
  • "externalId": "ad690eac-8108-4f69-a37c-6c407999dd59",
  • "person": {
    },
  • "apiKey": "3dfdc1ed-ce72-46d1-89c9-376df0f83237"
}

Response samples

Content type
application/json
{
  • "customerId": "e3c53333-2552-46ce-b2de-752c094b9cf6"
}

Получение дат, на которые есть доступные интервалы времени для создания предварительной записи

Request Body schema: application/json
apiKey
string or null

Ключ доступа к API.

officeId
string or null

Идентификатор запрашиваемого места. Из метода “Получение информации о всех доступных местах” поле offices.id

lineId
string or null

Идентификатор выбранной очереди при создании записи. Из метода “Получение информации о всех доступных местах” поле lines.id

serviceId
string or null

Идентификатор выбранной услуги, для которой необходимо получить доступные даты и время записи. Из метода “Получение информации о всех доступных местах” поле services.id

units
integer or null <int32>

Количество единиц услуги, указанное пользователем при записи. Если параметр не задан, будет выполнен поиск доступных дат для одной единицы услуги.

appointmentId
string or null

Идентификатор существующей записи. Передается, если необходимо изменить дату или время уже созданной записи.

Если редактируем существующую запись - получаем идентификатор из метода "Получение данных о заявителе, его активных записях и истории прошлых записей" (поле appointments.id).

или

Если создаем запись - получаем идентификатор из метода "Создание записи" (поле appointments.id).

Responses

Request samples

Content type
application/json
{
  • "officeId": "0fcab951-92e8-49a0-af78-f95c459f74bc",
  • "lineId": "33add1ef-2d42-4d67-b098-56d87a2f988f",
  • "serviceId": "da204cee-98ad-4a3e-872d-9f9b7c5d89e7",
  • "units": 2,
  • "appointmentId": "75ee8a60-7cf6-4ecc-b17e-bb53db3035b4",
  • "apiKey": "3dfdc1ed-ce72-46d1-89c9-376df0f83237"
}

Response samples

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

Получение информации о конкретном офисе обслуживания

Request Body schema: application/json
apiKey
string or null

Ключ доступа к API.

officeId
string or null

Идентификатор запрашиваемого места. Из метода “Получение информации о всех доступных местах” поле offices.id

Responses

Request samples

Content type
application/json
{
  • "officeId": "0fcab951-92e8-49a0-af78-f95c459f74bc",
  • "apiKey": "3dfdc1ed-ce72-46d1-89c9-376df0f83237"
}

Response samples

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

Статистическая информация об офисе

Request Body schema: application/json
apiKey
string or null

Ключ доступа к API.

officeId
string or null

Идентификатор запрашиваемого места. Получается из метода "Получение информации о всех доступных местах" (поле offices.id).

Responses

Request samples

Content type
application/json
{
  • "officeId": "0fcab951-92e8-49a0-af78-f95c459f74bc",
  • "apiKey": "3dfdc1ed-ce72-46d1-89c9-376df0f83237"
}

Response samples

Content type
application/json
{
  • "officeInfo": {
    },
  • "linesStatistics": [
    ]
}

Получение информации о всех доступных офисах обслуживания

Request Body schema: application/json
apiKey
string or null

Ключ доступа к API.

Responses

Request samples

Content type
application/json
{
  • "apiKey": "3dfdc1ed-ce72-46d1-89c9-376df0f83237"
}

Response samples

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

Проверка доступности сервиса

Responses

Response samples

Content type
application/json
"string"

Получение информации об обслуживаемой на текущий момент оператором записи

Request Body schema: application/json

test

apiKey
string or null

Ключ доступа к API.

operator
string or null

ФИО или email оператора.

  • Если передается ФИО, система ищет оператора, у которого ФИО полностью совпадает с переданным значением.
  • Если передается email, система ищет оператора, у которого логин (email) полностью совпадает с переданным значением.

Responses

Request samples

Content type
application/json
{
  • "operator": "operator@example.com",
  • "apiKey": "3dfdc1ed-ce72-46d1-89c9-376df0f83237"
}

Response samples

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

Получение ближайших офисов и ближайших временных интервалов, доступных для предварительной записи на выбранную услугу с заданным количеством

Request Body schema: application/json
apiKey
string or null

Ключ доступа к API.

serviceId
string or null

Идентификатор услуги, для которой требуется получить доступные временные слоты для записи. Из метода “Получение информации о всех доступных местах” поле services.id

serviceUnits
integer <int32>

Количество единиц услуги, на которое требуется записаться.

latitude
number or null <double>

Широта местоположения пользователя.

longitude
number or null <double>

Долгота местоположения пользователя.

officeCount
integer or null <int32>

Максимальное количество мест, в которых есть свободные слоты для записи на указанную услугу.

Responses

Request samples

Content type
application/json
{
  • "serviceId": "da204cee-98ad-4a3e-872d-9f9b7c5d89e7",
  • "serviceUnits": 10,
  • "latitude": 56.8355,
  • "longitude": 60.6057,
  • "officeCount": 2,
  • "apiKey": "3dfdc1ed-ce72-46d1-89c9-376df0f83237"
}

Response samples

Content type
application/json
{
  • "serviceName": "Оформление паспорта",
  • "serviceUnits": 1,
  • "offices": [
    ]
}

Получение временных интервалов, доступных для предварительной записи на выбранную услугу

Request Body schema: application/json
apiKey
string or null

Ключ доступа к API.

officeId
string or null

Идентификатор места, в котором осуществляется запись. Из метода “Получение информации о всех доступных местах” поле offices.id

lineId
string or null

Идентификатор выбранной очереди при создании записи. Из метода “Получение информации о всех доступных местах” поле lines.id

serviceId
string or null

Идентификатор выбранной услуги, для которой необходимо получить доступные даты и время записи. Из метода “Получение информации о всех доступных местах” поле services.id

units
integer <int32>

Количество единиц услуги, указанное пользователем при записи.

date
string or null

Дата, на которую требуется получить доступное время записи.

Формат: год-месяц-день (например, 2023-05-11)

appointmentId
string or null

Идентификатор существующей записи. Передается, если необходимо изменить дату или время уже созданной записи.

Если редактируем существующую запись - получаем идентификатор из метода "Получение данных о заявителе, его активных записях и истории прошлых записей" (поле appointments.id).

или

Если создаем запись - получаем идентификатор из метода "Создание записи" (поле appointments.id).

Responses

Request samples

Content type
application/json
{
  • "officeId": "0fcab951-92e8-49a0-af78-f95c459f74bc",
  • "lineId": "33add1ef-2d42-4d67-b098-56d87a2f988f",
  • "serviceId": "da204cee-98ad-4a3e-872d-9f9b7c5d89e7",
  • "units": 10,
  • "date": "2023-05-11",
  • "appointmentId": "75ee8a60-7cf6-4ecc-b17e-bb53db3035b4",
  • "apiKey": "3dfdc1ed-ce72-46d1-89c9-376df0f83237"
}

Response samples

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