QR

Разработчикам / REST API для BOOCO Meteor (v 1.x) / Общее API

Эндпоинты используются для создания и получения QR-кодов для различных действий (например, для бронирования и др.).

Endpoints

Endpoint
Метод
Описание
Queries
Body (JSON)
Значение поля data
Права (ресурс)
Версия
POST

Создает временный QR-код для :action. QR-код живет lfietime и потом удаляется. Каждый QR-код имеет уникальный случайно-сгенерированный ID и содержит ссылку http(s)://<host>/user/service?id=qr&qr=<уникальный ID>. Протокол и хост определяются из запроса.

lifetimesocketIdwidthmarginscaletypeerrorCorrectionLeveldarkColorlightColor

Параметры для :action

Изображение в формате base64

1.38.0

GET

Получить список созданных и действительных QR-кодов.

POST

Создает QR-код для подключения к сети WiFi. Данный метод не требует авторизации.

widthmarginscaleerrorCorrectionLeveldarkColorlightColortype

QRWifiOptions

Изображение в формате base64

GET

Создает постоянный QR-код для работы с ресурсами.

widthmarginscaledarkColorlightColortype

Изображение в формате base64

1.50.0

Параметры запроса (Queries)

Queries
Описание
Тип значения
Обязательный
Значение по умолчанию

Время жизни QR-кода в миллисекундах. После создания QR-код доступен в течение указанного времени, после чего удаляется.

number
нет

300000 (5 мин)

ID-сокета, который выдается при подключении к порту (tcp или websocket). Если указан, то когда пользователь совершит действие, указанное при создании QR-кода, на данный сокет будет отправлено уведомление с параметром resource = qr и данными от выполнения запроса.

string
нет

Ширина QR-кода в пикселях. Имеет преимущество по отношению к scale. Если ширина указана слишком маленькая, то значение игнорируется.

number
нет

Ширина поля

number
нет

4

Размер пикселя QR-кода. Если значение 1, то каждая точка QR-кода занимает 1 x 1 пиксель.

number
нет

4

Тип изображения. Может принимать значение image/png, image/jpeg, image/web. При любом случае возвращаемое значение будет в формате: data:image/png;base64.

number
нет

Определяет уровень корректировки ошибок. Возможные значения L, M, Q, H или low, medium, quartile, high.

string
нет

M

Цвет точек QR-кода. Значение должно быть в hex-формате RGBA. darkColor всегда должен быть более темным по сравнению с lightColor

string
нет

#000000ff

Цвет фона QR-кода. Значение должно быть в hex-формате RGBA.

string
нет

#ffffffff

Параметры URL

Name
Описание
Тип значения

Тип действия для которого нужно сгенерировать QR-код.

string

ID ресурса, например, C2-205, cnf.8.02

string

Действия для QR-кодов

Name
Описание
Параметры тела (JSON)

Создать QR-код для бронирования помещения. Обязательно должно быть поле venueId. После сканирования QR-кода и авторизации создается бронирование с указанными параметрами. В качестве организатора берется текущий пользователь (тот кто сканировал и авторизовывался).

Параметры такие же, как при создании бронирования - BookQROptions

Типы

type QRWifiOptions = {
  ssid?: string; // SSID сети WiFi, обязательный параметр
  password?: string; // Пароль
  security?: 'WPA' | 'WEP' | 'WPA2-EAP' | 'nopass'; // Тип авторизации
  eap?: 'TTLS' | 'PWD'; // TTLS или PWD (для WPA2-EAP)
  anonymous? : string; // Anonymous identity (для WPA2-EAP)
  identity?: string; // Identity (для WPA2-EAP)
  hidden?: boolean | string; // ture, если скрытая сеть
  phase2?: string; // Phase 2 method, например, MSCHAPV2 (для WPA2-EAP)
};

type BookQROptions = {
  venueId?: string;
  start?: TDateISO;
  end?: TDateISO;
};