Создание компании и её адрес

Полный перечень полей — в глоссарии.

​

Обзор

Эта страница описывает, как в Yume заводится и хранится сама компания и её домены. Здесь собраны: центральная запись компании и её вычисляемые поля, привязанные к ней домены, создание новой компании (создание записи, стартового пробного периода, дефолтных справочников и настроек), регистрация кастомного домена, справочники стран/валют/типов компаний и два пути регистрации компании.

​

Модель данных

​

Компания

Это основная запись компании. Она одновременно является техническим описанием компании (к ней привязаны все её данные) и коммерческой карточкой (владелец, оформление).

​

Вычисляемые поля: Ссылка и Код типа

Список компаний при каждом запросе дополняется двумя вычисляемыми полями:

• Ссылка (домен) — основной (primary) домен компании в зоне .yume.cloud. Если такого домена нет, подставляется запасное значение account.yume.cloud.
• Код типа — машинный код типа компании, подтянутый из связанного справочника типов.

Кроме того, задаётся порядок сортировки списка компаний: сначала по дате окончания периода (сначала записи без даты, затем от более поздних к более ранним), затем по убыванию идентификатора.

​

Домен компании

Домен привязывается к компании и описывает, как до неё «дотянуться» из интернета. Обычные поддомены вида <название>.yume.cloud считаются верифицированными сразу. Признак «кастомный домен» ставится для собственных доменов клиента — их нужно дополнительно проверить и зарегистрировать во внешней системе (см. раздел о регистрации кастомного домена).

​

Справочники: типы компаний, страны, валюты

Тип компании — это редактируемый справочник сфер деятельности (прокат авто, самокатов и т. п.). У каждого типа есть отображаемое название, машинный код, иконка, флаги «опубликован» и «активен», порядок сортировки и привязка к стране. Публичный список типов сортируется по полю порядка. Страна — фиксированный перечень поддерживаемых стран: Казахстан и ОАЭ. Валюта — фиксированный перечень поддерживаемых валют: тенге, доллар США, рубль, евро, узбекский сум, киргизский сом, дирхам ОАЭ, саудовский риял. Рядом с типами компаний в системе объявлен и перечень функциональных возможностей (продукты, комплекты, услуги, инвентарь, автомобиль, автоштрафы, различные режимы аренды и инвентаризации и т. д.) — он используется при настройке того, какие функции доступны типу компании и самой компании.

​

Привязка периодической задачи к компании

Отдельная сущность связывает запланированную периодическую задачу с конкретной компанией, делая фоновую задачу зависимой от компании. При сохранении привязки система:

1. Прописывает идентификатор компании в служебные заголовки задачи — благодаря этому задача при запуске выполнится в контексте нужной компании.
2. Если у задачи есть расписание по времени и включён флаг часового пояса компании — пересчитывает расписание из часового пояса компании; иначе использует UTC.

Дополнительно при сохранении самой периодической задачи система автоматически «выравнивает» её с компанией: если привязка уже есть — обновляет заголовки при расхождении, если привязки ещё нет — создаёт её на основе идентификатора компании и флага часового пояса, взятых из заголовков задачи. Компания при этом ищется через кэш; если по идентификатору компания не найдена или контекст компании не определён, выравнивание тихо пропускается.

​

Как создаётся новая компания

Создание компании — это единая операция, которая заводит компанию «под ключ»: одну запись компании, стартовый период, домен, членство владельца, лимиты и полный набор дефолтных справочников и настроек. Всё это выполняется в одной транзакции — при сбое ничего не остаётся «наполовину созданным».

​

Что именно создаётся

Стартовый период — пробные 7 дней от момента создания. Это и есть первичный «триал», по истечении которого требуется оплата. Домен — если при создании передан поддомен, создаётся домен вида <поддомен>.yume.cloud. Если поддомен не передан, домен не создаётся, и «Ссылка» компании остаётся запасной (account.yume.cloud). Членство владельца — владелец добавляется в компанию как администратор с правами суперпользователя и сотрудника. Лимиты плана — создаётся начальный набор лимитов (см. ниже). Дефолтные справочники (создаются как стартовое наполнение компании):

• Период времени «День» (длительность — одни сутки).
• Пункт проката «Пункт проката» с адресом-заглушкой.
• Метки клиентов: «Хороший» и «Плохой».
• Категория «Категория».
• Статусы состояния инвентаря: «Исправен» (без блокировки) и «Сломан» (с блокировкой).
• Способы привлечения клиентов: «Instagram», «Whatsapp», «Сарафанка».
• Типы оплаты: «Kaspi QR», «Kaspi RED», «Наличные».

Настройки компании — записи с названием, адресом, валютой и языком. Язык выбирается по стране: для ОАЭ — английский, для остальных — русский. Демо-доступ — набор интеграций, который компания получает сразу при создании (см. раздел «Демо-доступ новой компании»). Уведомление администратора — в конце в административный Telegram-канал отправляется уведомление «РЕГИСТРАЦИЯ КОМПАНИИ». В него вкладывается состав подключённых интеграций, поэтому на всю регистрацию уходит одно сообщение, а не по одному на каждый модуль.

​

Стартовые лимиты плана

Генерация лимитов добавляет только те лимиты, которых у компании ещё нет (существующие не трогает), а затем сбрасывает кэш лимитов компании. Начальный набор: Эта же генерация вызывается повторно при открытии карточки компании, если число сохранённых лимитов не совпадает с полным перечнем типов лимитов — тогда недостающие лимиты будут дозаведены на лету.

​

Демо-доступ новой компании

Сразу после создания компания получает набор подключённых интеграций — иначе в только что заведённой компании не было бы даже аренды. Набор собирается из ответов онбординга, которые передаются вместе с данными компании и на самой компании не сохраняются: Если сфера не указана, она выводится из типа компании: типы «такси» и «авто» дают транспорт, все остальные — инвентарь. Что попадает в набор: Правила подключения одинаковы и при создании компании, и при массовом подключения из кабинета:

• Демо ставится только если у интеграции задана ненулевая длительность демо.
• Подключение, у которого уже есть демо-срок, оплаченный срок или тариф, не передатируется — то же правило, что и у ручного подключения («Демо-режим уже использован»). Если оно было отключено, его просто включают обратно.
• Неизвестные коды, повторы в списке и интеграции, которым не хватает обязательных полей настройки, пропускаются — один неверно настроенный модуль не роняет весь набор.
• Весь набор идёт одной транзакцией и даёт одно сообщение в административный канал со списком «интеграция — до какого числа — демо или нет».

​

Единственный путь создания компании

Компанию создаёт только отдельный запрос на создание компании — от уже вошедшего пользователя, с названием, адресом, типом, валютой, страной, поддоменом и ответами онбординга. Формат валидирует поддомен, после чего запускает провижининг. Создание разрешено только вне контекста конкретной компании; при попытке создать компанию, когда в запросе уже определена активная компания, вернётся отказ с предложением обратиться в поддержку по указанному телефону.

​

Домены и поддомены

​

Проверка занятости поддомена

Перед регистрацией фронтенд проверяет, свободен ли желаемый поддомен. Правила:

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

Список зарезервированных (служебных) имён включает такие значения, как docs, manager, yume, api, dev, widget, auth, cabinet, landing, domain, app, prod, stage. При фактическом создании компании поддомен проверяется ещё строже: сверка с зарезервированными именами и точная проверка «домен начинается с <поддомен>.». Если поддомен занят или зарезервирован — создание отклоняется с сообщением, что такой домен уже существует.

​

Регистрация кастомного домена

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

1. Берёт домен, помеченный как кастомный. Если такого нет — завершается.
2. Проверяет счётчик повторов: если он достиг предела (30 попыток) — прекращает попытки.
3. Разрешает домен в IP-адрес. Если DNS ещё не отвечает — планирует повтор через 15 минут. Если IP не совпадает с ожидаемым адресом платформы — завершается с сообщением о несовпадении.
4. Если IP совпал — обращается к внешнему сервису регистрации (с ключом доступа). При успешном ответе помечает домен верифицированным и проставляет дату верификации. При неуспехе или ошибке связи — планирует повтор через 15 минут.

​

Как это используется

​

API компаний и справочников

• Список компаний / создание компании — возвращает компании, где текущий пользователь является администратором-сотрудником; создание доступно только вне контекста конкретной компании. Это единственная точка, создающая компанию, и она же принимает ответы онбординга (сфера, модули), формирующие демо-набор.
• Карточка компании — чтение и обновление данных текущей компании; при открытии дозаводит недостающие лимиты. Если компания в запросе не определена, возвращается 404 с сообщением «Пользователь не подключён к компании» — тот же ответ, что и для несуществующей компании, вместо ошибки на пустом объекте.
• Массовое подключение интеграций — подключает сразу список модулей (POST /v1/crm/integrations/bulk_connect/), по тем же правилам, что и демо-набор при регистрации: пропуск неизвестного и ненастраиваемого, одна транзакция, одно сообщение администраторам. В ответе — список того, что действительно подключилось.
• Список типов компаний — публичный справочник, отсортированный по порядку.
• Шаги онбординга — список и отметка пройденных шагов для текущей компании.
• Заявка на демо — принимает телефон, ФИО и сферу деятельности и отправляет уведомление в административный Telegram-канал.
• Проверка поддомена — см. выше.

​

Инвалидация кэша компании

Компании кэшируются (по идентификатору и по именам доменов). При обновлении записи компании кэш сбрасывается автоматически: удаляется запись по идентификатору и записи по всем доменам этой компании. При создании компании сброс кэша не выполняется (кэшировать ещё нечего).

​

Устаревший вход компании

Есть отдельная точка входа компании, возвращающая данные сессии, но с пустым идентификатором компании в ответе. Она помечена как устаревшая и подлежит удалению после обновления мобильных приложений — новый код на неё завязывать не следует.

​

Связанные страницы