Vibe

Общая информация

Топики Kafka

  • activity - события связанные с пользователями
  • events - События (мероприятия)
  • orders - Заказы (первичные и вторичные)
  • tickets - Билеты
  • transactions - Транзакции

Формат сообщений

Сообщения передаются в JSON формате (ниже представлены типы сообщений в typescript)

Подключение к Kafka

Подробнее

Production

  • Bootstrap servers:

    • rc1a-agdu796r4205p5ip.mdb.yandexcloud.net:9091
    • rc1b-2vq60gur5r18vpu5.mdb.yandexcloud.net:9091
    • rc1d-ft6jeu47b9bp2aff.mdb.yandexcloud.net:9091
  • Security protocol: SASL_SSL

  • SASL mechanism: SCRAM-SHA-512

  • SSL CA certificate: https://storage.yandexcloud.net/cloud-certs/CA.pem

  • SASL Username: предоставляется по запросу

  • SASL Password: предоставляется по запросу

Stage/Dev

  • Bootstrap servers:

    • rc1a-faass3ffar5s5q6o.mdb.yandexcloud.net:9091
  • Security protocol: SASL_SSL

  • SASL mechanism: SCRAM-SHA-512

  • SSL CA certificate: https://storage.yandexcloud.net/cloud-certs/CA.pem

  • SASL Username: предоставляется по запросу

  • SASL Password: предоставляется по запросу

Мероприятия (events)

Содержит 2 типа сообщений:

  • type=event Мероприятия
  • type=participation Настройки пользователя (оповещения, сокрытие)
 
export type EventMessage = {
	type: "event"
	
	// Внешний идентификатор мероприятия
	id: string;
	
	// Идентификатор билетной системы
	// TC - Ticketscloud
	// TICKETLAND - Ticketland
	system: "TC" | "TICKETLAND" | "MRS_RESTAURANTS" | "MRS_CINEMA";
	
	// Дата/время создания события (timestamp)
	created: number;
	
	// Дата/время последнего обновления события (timestamp)
	updated: number;
	
	// Название
	name: string;
	
	// Статус мероприятия
	state: "new" | "published" | "paused" | "canceled" | "finished";
	
	// Дата/время начала события (timestamp)
	start: number | null;
	
	// Дата/время окончания события (timestamp)
	end: number | null;
	
	// Возрастной рейтинг
	age_restriction: number | null;
	
	// Категория мероприятия
	category: string | null;
	
	// Минимальная цена билетов (в копейках/центах)
	price_min: number | null;
	
	// Валюта мероприятия (ISO-4217)
	currency: string;
	
	// Рейтинг
	rating: number;
	
	// Картинка мероприятия
	media: string | null;
	
	// Разрешены ли возвраты
	is_refundable: boolean;
	
	// Разрешена ли передача билетов
	is_transferable: boolean;
	
	// ID группы мероприятий (для групповых сеансов)
	group_id: string;
	
	// ID города (geobase)
	city_id: string | null;
	
	// Внешний идентификатор организатора
	organizer_id: string;
	
}
 
export type ParticipationMessage = {
	type: "participation"
	
	// Дата/время создания (timestamp)
	created: number;
	
	// ID пользователя (номер телефона в формате E164)
	customer_id: string;
	
	// Внешний идентификатор мероприятия
	event_id: "9c02131167274e238cd6f8da929b0693"
	
	// Идентификатор билетной системы
	// TC - Ticketscloud
	// TICKETLAND - Ticketland
	system: "TC" | "TICKETLAND" | "MRS_RESTAURANTS" | "MRS_CINEMA";
	
	// Пользователь скрыл мероприятие
	hidden: boolean
	
	// Оповещения связанные с мероприятием включены/выключены для пользователя
	notify: boolean
	
}

Заказы (orders)

В топике 2 типа сообщений:

  • type=primary Первичные заказы
  • type=secondary Вторичные заказы
 
export type Message = {
	// Тип заказа 
	// - primary: первичный заказ
	// - secondary: вторичный заказ (перепродажа билета)
	
	type: "primary" | "secondary"
	
	// Идентификатор заказа (TC, TICKETLAND, VIBE)
	id: string;
	
	// Идентификатор билетной системы
	// TC - Ticketscloud
	// TICKETLAND - Ticketland
	system: "TC" | "TICKETLAND" | "MRS_RESTAURANTS" | "MRS_CINEMA";
	
	// Сумма заказа (в копейках/центах)
	amount: number;
	
	// Валюта заказа (ISO-4217)
	currency: string;
	
	// ID пользователя (номер телефона в формате E164)
	customer_id: string;
	
	// Дата/время заказа (timestamp)
	done_at: number
	
	// Номер заказа (только для primary)
	number?: string
	
	// ID продавца (номер телефона в формате E164)
	// только для secondary
	seller_id?: string;
 
}

Билеты (tickets)

 
export type Message = {
	// Внешний идентификатор билета
	id: string;
	
	// Идентификатор билетной системы
	// TC - Ticketscloud
	// TICKETLAND - Ticketland
	system: "TC" | "TICKETLAND" | "MRS_RESTAURANTS" | "MRS_CINEMA";
	
	// Дата создания (timestamp)
	created: number;
	
	// Дата обновления (timestamp)
	updated: number;
	
	// Статус билета
	status: "active" | "used" | "refunded";
	
	// Цена билета (номинал, в копейках/центах)
	price_nominal: number;
	
	// Последняя цена перепродажи билета (номинал, в копейках/центах)
	price_last: number | null;
 
	// Валюта билета (ISO-4217)
	currency: string;
	
	// Название категории билета
	category: string | null;
	
	// Кол-во передач билета
	hops: number;
	
	// Внешний идентификатор мероприятия
	event_id: string;
	
	// Внешний идентификатор заказа
	order_id: string;
	
	// Кол-во использований билета
	uses: number;
	
	// Билет можно передать/продать
	transferable: boolean;
	
	// ID пользователя (номер телефона в формате E164)
	customer_id: string;
}

Транзакции (transactions)

См. также типы транзакций

 
export type Message = {
	// Внешний идентификатор транзакции
	id: string;
	
	// Идентификатор билетной системы
	// TC - Ticketscloud
	// TICKETLAND - Ticketland
	system: "TC" | "TICKETLAND" | "MRS_RESTAURANTS" | "MRS_CINEMA";
	
	// Тип транзакции 
	type: "allocate" | "subscription" | "sell" | "referral" | "withdrawal" | "donate" | "refill" | "burn" | "refund" | "redeem" | "transfer" | "escrow_unlock" | "escrow_canceled" | "reward";
	
	// Дата создания (timestamp)
	created: number;
	
	// Дата обновления (timestamp)
	updated: number;
	
	// Сумма транзакции (в копейках/центах)
	amount: number | null 
	
	// Валюта транзакции (ISO-4217)
	currency: string;
	
	// Владелец транзакции (номер телефона в формате E164)
	owner_id: string;
	
	// Участник транзакции (номер телефона в формате E164)
	customer_id: string
	
	// Внешний ID события
	event_id: string;
	
	// Внешний ID билета
	ticket_id: string;
}

События пользователей (activity)

Авторизация/регистрация

 
export type Message = {
	// Тип сообщения
	// auth - авторизация
	// register - регистрация
	type: "register" | "auth";
	
	// Дата/время события (timestamp)
	created: number;
	
	// Информация о пользователе
	customer: {
		// ID в Vibe
		id: string;
		
		// Имя фамилия, никнейм в зависимости от заполнения
		name: string | null;
		
		// Номер телефона в формате E164
		phone: string;
		
		// Email
		email: string | null;
		
		// Дата/время создания пользователя (timestamp)
		created: number;
		
		// Дата/время обновления пользователя (timestamp)
		updated: number;
	}
}

Маркетинг (marketing)

В топике 4 типа сообщений:

  • type=campaign Маркетинговые акции
  • type=participation Участие в акциях
  • type=promo Промо-компании
  • type=push Пуш-рассылки
export type CampaignMessage = {
 
	// Сообщение указывает на акцию
	type: "campaign";
	
	// ID  в Vibe
	id: number;
	
	// Признак включения/выключения акции
	is_active: boolean;
	
	// Статус акции
	status: "ongoing" | "finished" | "canceled"
	
	// Дата/время создания (timestamp)
	created: number;
	
	// Дата/время обновления (timestamp)
	updated: number;
	
	// Дата/время начала акции (timestamp)
	start: number;
	
	// Дата/время окончания акции (timestamp)
	end: number;
	
	// Названия акции
	title: string;
	title_in_app: string;
	
	// Описание акции
	description: string | null;
	
	// Лимит участников
	usage_limit: number;
	
	// Сумма и валюта награждения
	reward: number;
	currency: string;
}
 
export type CustomerCampaignMessage = {
 
	// Сообщение указывает на участие акцию
	type: "participation";
	
	// ID  в Vibe
	id: number;
	
	// Дата/время создания (timestamp)
	created: number;
	
	// Дата/время обновления (timestamp)
	updated: number;
	
	// Дата/время участия (timestamp)
	participate_date: number
	
	// Дата/время получения награды (timestamp)
	reward_date: number | null
	
	// ID Акции
	campaign_id: number
	
	// Участник акции (номер телефона в формате E164)
	customer_id: string
	
}